- Notifications
You must be signed in to change notification settings - Fork0
A react web project template 👷 Built with a sense of peace and tranquillity 🙏
License
chrispoulter/halcyon
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
A react web project template 👷 Built with a sense of peace and tranquillity 🙏
- Vitehttps://vite.dev/
- Reacthttps://react.dev/
- React Routerhttps://reactrouter.com/
- TanStack Queryhttps://tanstack.com/query
- Shadcn UIhttps://ui.shadcn.com/
- React Hook Formhttps://react-hook-form.com/
- Zodhttps://zod.dev/
- Tailwind CSShttps://tailwindcss.com/
- Dockerhttps://www.docker.com/
- GitHub Actionshttps://github.com/features/actions
- Halcyon APIhttps://github.com/chrispoulter/halcyon-api
Install NPM packages:
npm install
For local development, you'll need to create a.env.local
file in the root of the project to define the environment variables. This file is ignored by Git, so the secrets will not be committed to the repository.
VITE_API_URL=http://localhost:5257
Once the dependencies are installed, you can run the development server:
npm run dev
Openhttp://localhost:5173 in your browser to see the project running.
To build the project for production:
npm run build
This command will create an optimized build in thedist
folder.
To lint and format the code:
npm run lintnpm run format
Feel free to submit issues or pull requests to improve the template. Ensure that you follow the coding standards and test your changes before submission.
This project is licensed under the MIT License. See theLICENSE file for details.
About
A react web project template 👷 Built with a sense of peace and tranquillity 🙏