Next.js Boilerplate

Overview

Next.js 14 with App Router boilerplate template including:

Base Next.js 14

• ⚛️ React 18
• ✨ TypeScript
• 💨 Tailwind CSS 3
• 📏 ESLint

Additional

• 🌈 Prisma ORM
• 🐘 PostgreSQL 16 (docker-compose container)
• 🃏 Jest + React Testing Library
• 💖 Prettier
• 👷 GitHub Actions (CI + Dependabot config)

Getting started 🚀

1. Install dependencies

Install npm dependencies:

npm ci

2. Create and seed the database

If you're using Docker on your computer, the following script will set up a PostgreSQL database using the docker-compose.yml file at the root of your project:

npm run db:up

Model your data in the Prisma schema by editing the prisma/schema.prisma fiile

Run the following command to create your PostgreSQL database:

npx prisma migrate dev --name init

When npx prisma migrate dev is executed against a newly created database, seeding is also triggered. To add seeding, create a seed file in prisma/seed.ts and it will be executed against your database.

3. Configuring your environment

cp .env.example .env

Ensure these variables are correct.

4. Start the app

npm run dev

The app is now running, navigate to http://localhost:3000/ in your browser to explore its UI.

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.