novari-frontend-components
v3.2.0
Published
Frontend components for Novari, IKS
Downloads
529
Readme
Novari Frontend Components
Frontend component library for React.js applications using NAV Aksel design system. This package provides pre-styled UI components with consistent colors and layouts, making it easier to build modern, accessible applications.
Installation
npm install novari-frontend-componentsAvailable Components
NovariHeader- Main application header with navigation and user menuNovariFooter- Application footer with customizable linksNovariApiManager- HTTP client for API interactionsNovariInternalHeader- Internal page header componentNovariCircularProgressBar- Visually display progression of one value compared to another
Development
Prerequisites
- Node.js (v18 or higher)
- npm (v9 or higher)React
- NAV Aksel Design System
- TypeScript
- Tailwind
- React
Local Development
- Clone the repository:
git clone https://github.com/FINTLabs/novari-fontend-components.git
cd novari-fontend-components- Install dependencies:
npm install- Start Storybook for component development:
npm run storybookBuilding
npm run buildThis will:
- Run TypeScript compilation
- Generate rollup bundle
- Create distribution files in
lib/directory
Publishing
- Update version:
npm version patchnpm version minornpm version major- Publish to npm:
npm publish --access publicTesting Components
Run Storybook to test and develop components in isolation:
npm run storybookVisit http://localhost:6006 to view the Storybook interface.
Contributing
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
License
This project is licensed under the MIT License - see the LICENSE file for details.
Support
For support, please create an issue in the GitHub repository or contact the maintainers.
Built With
Project Status
Active development - This project is actively maintained and accepting contributions.
