fq-toolkit
v0.10.0
Published
Finqle Toolkit
Downloads
7
Readme
Finqle Toolkit
Finqle toolkit is the visual/style/markup of the company for web-based projects.
Develop something
The project is currently running on node 10 (lts) and npm v6.x+. To run the
project, type npm install && npm run serve
and access http://localhost:8081
to have an overview of current components. You can have access to the output at
http://localhost:8081/css/style.css
If you are a unix-based user, you can type ./createComponent [YourComponent]
to
have a _yourcomponent.scss and yourcomponent.html ready to be used.
Remember to use the BEM syntax to create the components keep the coding standard.
Contributing
This project is served as a npm package to the users. Please be sure your new
component has been linted properly by running npm run lint
before publish on
npm. to quick-fix something, type npm run lint -- --fix
and try to publish
again.
It's advisable to install prettier
and eslint
extensions on your IDE, so you
can keep on track mistakes on coding standards during your coding sessions.