EuCarlos / boilerplate-vite-react-ts

Boilerplate TS

🌐 Para a versão em português deste README, clique aqui.

Boilerplate with ReactJS, VITE and TypeScript by @EuCarlos

Summary

• 1. Installation:
• 2. Run the project
• 3. Documentation
• 4. How to contribute to this project?
• 5. How do I report a bug or request a feature?

1. Installation:

Clone the repo and Install dependencies using Yarn:

git clone https://github.com/EuCarlos/boilerplate-vite-react-ts.git <project-name> \
  && cd <project-name> \
  && yarn install

2. Run the project

yarn dev

3. Documentation

All components should be documented using storybook, and can be accessed on port 6006

4. How to contribute to this project?

Before starting, check and follow the instructions for contributing to the repository. If not, you can follow the instructions below:

1. Fork the project
2. Create a new branch: git checkout -b nova-branch
3. Commit your changes: git commit -m 'I added something'
4. Push to branch: git push origin nova-branch
5. Open a Pull Request

5. How do I report a bug or request a feature?

If you want to report a bug or request a feature, go to Issue on the GitHub Project and add your request.

---

Created with 💜 by Carlos Alves