https://github.com/chrispoulter/halcyon-nextjs
A Next.js web project template 👷 Built with a sense of peace and tranquillity 🙏
https://github.com/chrispoulter/halcyon-nextjs
docker drizzle-orm eslint github-actions next-safe-action nextjs prettier react react-email react-hook-form shadcn-ui tailwindcss typescript zod
Last synced: 11 months ago
JSON representation
A Next.js web project template 👷 Built with a sense of peace and tranquillity 🙏
- Host: GitHub
- URL: https://github.com/chrispoulter/halcyon-nextjs
- Owner: chrispoulter
- License: mit
- Created: 2020-02-25T09:03:09.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-06-23T16:10:28.000Z (11 months ago)
- Last Synced: 2025-06-23T17:25:54.606Z (11 months ago)
- Topics: docker, drizzle-orm, eslint, github-actions, next-safe-action, nextjs, prettier, react, react-email, react-hook-form, shadcn-ui, tailwindcss, typescript, zod
- Language: TypeScript
- Homepage:
- Size: 3.49 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Halcyon Next.js
A Next.js web project template 👷 Built with a sense of peace and tranquillity 🙏
## Features
- Next.js
[https://nextjs.org/](https://nextjs.org/)
- Next Safe Action
[https://next-safe-action.dev/](https://next-safe-action.dev/)
- Shadcn UI
[https://ui.shadcn.com/](https://ui.shadcn.com/)
- React Hook Form
[https://react-hook-form.com/](https://react-hook-form.com/)
- Zod
[https://zod.dev/](https://zod.dev/)
- Tailwind CSS
[https://tailwindcss.com/](https://tailwindcss.com/)
- React Email
[https://react.email/](https://react.email/)
- Drizzle ORM
[https://orm.drizzle.team/](https://orm.drizzle.team/)
- Docker
[https://www.docker.com/](https://www.docker.com/)
- GitHub Actions
[https://github.com/features/actions](https://github.com/features/actions)
## Getting Started
### Prerequisites
- PostgreSQL
[https://www.postgresql.org/](https://www.postgresql.org/)
- MailDev
[https://github.com/maildev/maildev](https://github.com/maildev/maildev)
### Install dependencies
Install NPM packages:
```
npm install
```
### Configure environment variables
For local development, you'll need to create a `.env` 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.
```
DATABASE_URL=postgres://postgres:password@localhost:5432/halcyon-nextjs
EMAIL_SMTP_SERVER=localhost
EMAIL_SMTP_PORT=1025
EMAIL_SMTP_SSL=
EMAIL_SMTP_USERNAME=
EMAIL_SMTP_PASSWORD=
EMAIL_NO_REPLY_ADDRESS=noreply@example.com
SEED_EMAIL_ADDRESS=system.administrator@example.com
SEED_PASSWORD=super_secret_password_that_should_be_changed
SESSION_DURATION=3600
SESSION_SECRET=super_secret_key_that_should_be_changed
```
### Running the development server
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.
## Building for Production
To build the project for production:
```
npm run build
```
This command will create an optimized build in the `.next` folder.
## Linting & Formatting
To lint and format the code:
```
npm run lint
npm run format
```
## Contributing
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.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.