The main technologies used to develop the project were:
- React - A JavaScript library for building user interfaces.
- React router dom(v6) - Declarative routing for React apps at any scale.
- Typescript - TypeScript is JavaScript with syntax for types.
- Eslint - ESLint statically analyzes your code to quickly find problems.
- Prettier - Opinionated code formatter.
- Testing Library - Simple and complete testing utilities that encourage good testing practices
- Jest - Jest is a delightful JavaScript Testing Framework with a focus on simplicity.
- husky(v8) - Helps improve commits. You can use it to lint your commit messages, run tests, lint code, etc... when you commit or push.
- storybook - Storybook is a frontend workshop for building UI components and pages in isolation.
This project was bootstrapped with:
- Vite - Next generation frontend tooling. It's fast!
Before starting, make sure you've met the following requirements:
- node(versions 14.x.x or later)
- npm(versions 5.x.x or later)
To start the project, follow these steps:
Clone the project:
git clone https://github.com/MarcosSantosDev/react-playground.git
Install the dependencies
npm install
To start the application, run:
npm run dev
To start building the application, run:
npm run build
To start testing the application, run:
npm run test
To generate application test coverage, run:
npm run coverage
To start the app storybook, run:
npm run storybook
To start the app storybook build, run:
npm run build-storybook
To contribute, follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b <branch_name>. - Make your changes and commit them:
git commit -m '<message_commit>' - Push to the original branch:
git push origin <project_name> / <local> - Create the pull request.
Alternatively, see the GitHub documentation at how to create a pull request.
During the construction of the project, some standards were adopted, check the documentation below, before contributing:
This project is licensed under the MIT License - see the LICENSE file for details
Make with ❤️ by Marcos Santos