Table of Contents
About The Project
Web components library port of Inclusive components
Built With
Getting Started
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
Prerequisites
This is an example of how to list things you need to use the software and how to install them.
- node
- npm
npm install npm@latest -g
Installation
-
Clone the repo
git clone https://github.com/fstbraz/inclusive-web-components.git -
Install NPM packages
npm install -
The remainig commands for buid and testing are listed at
package.json
Usage
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources. (WIP)
For more examples, please refer to the Documentation
Roadmap
- [X] Initial Setup
- [X] First Component
- [ ] Unit Tests Setup
- [ ] Migrate the remaining components
- [ ] Storybook configuration
- [ ] Migrate to eslint
- [ ] Improvements
See the open issues for a full list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE for more information.
Contact
Twitter - @fstbraz
Project Link: https://github.com/fstbraz/inclusive-web-components