react-boilerplate

💻・About

React boilerplate to quickly setup projects!

Libs & Packages

• TailwindCSS
• SCSS
• TypeScript
• Sonner
• ShadcnUi
• Zustand

🎯・Setup

Clone this repo

git clone https://github.com/abroudoux/react-boilerplate

Install dependencies

npm i

or

yarn install

Configure your environment variables in .env

cp env.example .env

Run the project

npm run dev

Have fun !

🧑‍🤝‍🧑・Contributing

To use react-boilerplate in development, follow these steps:

1. Fork the project.

2. Install dependencies.

npm i

3. Create a branch with conventionnal name.

   • fix: bugfix/the-bug-fixed
   • features: feature/the-amazing-feature
   • test: test/the-famous-test
   • hotfix hotfix/oh-my-god-bro
   • wip wip/the-work-name-in-progress

📑・Licence

MIT License

Copyright (c) 2023 abroudoux

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.