0.2.0 • Published 5 years ago
sil-react v0.2.0
Service Innovation Lab Component Library
Install
npm install sil-react
Generate a component
npm run component
Delete all components and examples
npm run component:delAll
Docs
Why does this Component Library exist?
Benefits of a library approach:
- Reusable components
- Auto generated documentation
- Consistent look and feel
- Consistent API
- All components follow the same pattern
- Confidence the application we build will seem cohesive
- Easier to add a new component
- Simple organisation (DRY - Don't repeat yourself)
- Can add components quickly
- Reduces dependency management overhead
- Easier for developer to grasp how our application works
Installation
Clone the project.
In the project directory, you can run:
npm install
npm start
Runs the app in the development mode. Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits. You will also see any lint errors in the console.
npm test
Launches the test runner in the interactive watch mode. See the section about running tests for more information.
npm run build
Builds the app for production to the build
folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes. Your app is ready to be deployed!
See the section about deployment for more information.
npm run deploy
Deploys the Component library to gh-pages