- π Vite β A native ES modules development server and build tool.
- π Dependabot β Automated dependency updates for GitHub repositories.
- π§ ESLint β Pluggable JavaScript linter
- π¨ Prettier β Opinionated Code Formatter
- π Commitzen β Git commit message helper
- πΆ Husky β Use git hooks with ease
- π« Lint-staged β Run linters against staged git files
- π Axios β HTTP client library for JavaScript.
- π Styled-components β library for styling React components.
- π React-hook-form β lightweight library for building forms.
- π Zod β TypeScript-first schema validation.
To use this boilerplate as a template for your own project, follow these steps:
- Click on the
Use this template
button on this repository page to create a new repository from this template. - Choose a name and configure the new repository as desired.
- Clone the newly created repository to your local machine with the following command in your terminal:
git clone https://github.com/<YOUR_USERNAME>/<YOUR_PROJECT_NAME>.git
After cloning the repository, run the following commands inside the project folder:
- Install the dependencies with
npm install
- Start the project with
npm start
βββ π.github // GitHub workflows
βββ π.husky // Git hooks
|
βββ πsrc
| βββ π@types // Type definitions
| βββ πcomponents // React components
| βββ πhooks // Custom hooks
| βββ πpages // Pages or screens
| βββ πservice // API services
| βββ πstyles // Global styles
| βββ πtheme // Theme files
| βββ πutils // General utilities
| | βββπconstants // Global constants
| | βββπfunctions // Utility functions
| |
| βββ πindex.tsx // Main entry file
|
βββ π.eslintrc.json // ESLint configuration file
βββ π.prettierrc // Prettier configuration file
βββ πIndex.html // Entry point HTML file
βββ πREADME.md // Project documentation
βββ πpackage.json // NPM package configuration file
βββ πtsconfig.json // TypeScript configuration file
βββ πvite.config.ts // Vite configuration file
If you want to contribute to this template, follow these steps:
- Fork this repository
- Create a new branch with their feature using
git checkout -b my-feature
. - Commit their changes using
git commit -m 'Adding new feature'
. - Push the changes to their branch using
git push origin my-feature
. - Open a pull request on your repository.