A Next.js web project template 👷 Built with a sense of peace and tranquillity 🙏
- Next.js https://nextjs.org/
- TanStack Query https://tanstack.com/query
- React Hook Form https://react-hook-form.com/
- Zod https://zod.dev/
- Auth.js https://authjs.dev/
- Tailwind CSS https://tailwindcss.com/
- Vitest https://vitest.dev/
- Playwright https://playwright.dev/
- Docker https://www.docker.com/
- GitHub Actions https://github.com/features/actions
- Halcyon API https://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.
NEXT_PUBLIC_VERSION=1.0.0-local
NEXT_PUBLIC_API_URL=http://localhost:5257
JWT_SECURITY_KEY=super_secret_key_that_should_be_changed
JWT_ISSUER=HalcyonApi
JWT_AUDIENCE=HalcyonClient
AUTH_URL=http://localhost:3000
AUTH_SECRET=super_secret_key_that_should_be_changed
Once the dependencies are installed, you can run the development server:
npm run dev
Open http://localhost:3000 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 the .next folder.
To run unit tests:
npm run test
After installing the project dependencies, run the following command to install Playwright and its browser dependencies:
npm run e2e:install
To execute the E2E tests, use the following command:
npm run e2e:test
To lint and format the code:
npm run lint
npm 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 the LICENSE file for details.