A template allowing for rapid development of React SPA projects based on Vite.
Since this project is based on Vite, it is suggested you read the docs to familiarise yourself with how it serves locally, runs hot reloading, bundles files, handles env variables, etc. It is also a good idea to read the docs of any other listed tools you are unfamiliar with.
To learn more about the technologies used in this site template, see the following resources:
Project Scaffolding
- TypeScript - Typed superset of JavaScript
- ESLint - Enforcement of coding rules
- Prettier - Autoformatting code
- Husky + Lint Staged - Pre-commit hooks for ESLint & Prettier
- Vite - Next Generation Frontend Tooling Framework
- Renovate - Automated dependency updates
- GitHub Actions - Automated CI/CD
- Mend - Security scanning
Frontend Libraries
- Heroicons - Icon library from TailwindLabs
- Tailwind CSS - The official Tailwind CSS documentation
- Headless UI - The official Headless UI documentation
Testing
- Vitest - New testing framework based on Vite
- React Testing Library - The best testing library there is
Install dependencies
yarn
Next, create a .env
file in the root of your project and set the VITE_APP_
variable to your site's public URL:
VITE_APP_API_URL
Next, run the development server:
yarn dev
Finally, open http://localhost:3000 in your browser to view the website.
You can start editing this site by modifying the files in the /src
folder. The site will auto-update as you edit these files.