fql-components
v0.0.20
Published
Finqle components
Downloads
9
Readme
fq-components
Finqle components made in react for general usage
Project basics
Be sure you have node 10.x (lts recommended) installed and npm 6.x and type npm install
. This will install all dependencies.
You can run the storybook of the project by running npm run storybook
It will be available at http://localhost:6006
Contributing
Want to create a new component properly and don't know where to start? Use ./createComponent <<YourReactComponent>>
and the bash will output a proper example of a component, test and story file (for linux/unix-based users only).
- Bear in mind the scalability and maintainability of the project. When creating new components or update them, create tests with a good coverage for them.
- Also, take into account that this project uses Prettier and eslint to ensure the current coding standards. Take a look ad the documentation of these projects.