Skip to content

lipex360x/react-boilerplate

Repository files navigation

React Boilerplate

React + Typescript Boilerplate with Vite



📑 Content Index


⚡ Introduction

This is a boilerplate for React Project using Atomic Design with generator


⚡ Startup

  • Start project with this Templante

  • Install dependencies with yarn or npm install

  • run yarn dev or npm run dev


⚡ Changeble points

  • Configure Project Name in ./package.json

  • Configure Project Title in ./index.html

  • Configure Theme Styles in src/styles/constants

  • Configure Global Styles in src/styles/global.ts

  • Configure Theme in src/styles/themes/default.ts

  • Rename .env.example to .env and change API address (if necessary)

  • Change README.md

  • Change Screen Example in ./assets/screen.png


⚡ Generator

  • Run: yarn gen or npm run gen in terminal

  • Follow the instructions


⚡ Technologies

 Axios
 Immer
 React Hook Form
 React Hot Toast
 Styled Components
 Styled Media Query
 Zod
 Zustand
 Plop

👆 Go to Content Index


📌 Tips: for easier navigation by github, consider installing the Octotree plugin