NestJS + NextJS Starter Project by Kir-Dev

This is a starter project for a fullstack application using NestJS and NextJS. It includes a basic setup for a NestJS as backend and a NextJS as frontend, including shadcn/ui, ESLint, Prettier, and GitHub Actions.

Getting Started

Prerequisites

• Node.js 20
• Yarn 1.22

Installation

You only need to install dependencies in the root directory.

yarn install

Linter and Formatter Configuration

It is a must to use ESLint and Prettier in this project.

Set up ESLint and Prettier in your IDE and check fix on save or format on save options.

You can run the following commands to check linting and formatting issues.

yarn lint
# or
yarn lint:fix

yarn format:check
# or
yarn format

Development

Backend

Make sure to copy .env.example in the backend folder and name the new file .env.

After that, we should apply our database schema to the database itself, so run:

yarn setup:db:dev

Local start

You can run the backend and frontend separately.

yarn start:backend # Starts on http://localhost:3001

yarn start:frontend # Starts on http://localhost:3000

After Development

You can build the frontend and run the application.

yarn build:frontend

Or build the backend.

yarn build:backend

There are recommended GitHub Actions workflows for this setup, which will fail if one of the following commands fails:

yarn lint

yarn format:check

yarn build:backend

### If you don't have Postgres installed, but have Docker

Run this command to spin up a container with Postgres. The .env file is already modified to have the appropriate connection URL.

docker volume create sprintreview_db_folder
docker-compose up --build -d

Now you can start the dev backend with yarn start:backend.

Happy Coding!