Skip to content

kir-dev/BeAlcoholic

Repository files navigation

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

You can run the backend and frontend separately.

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

How to use Snaplet seeding

You can use the seeding script to populate your database with realistic mock data using the Snaplet Seed. From the Backend directory run the following command to sync up the seeding script with the prisma schema:

npx @snaplet/seed sync

Run the script using a TypeScript runner:

 yarn tsx seed.ts

Or you can include it into package.json:

  "prisma": {
    "seed": "tsx prisma/seed/seed.ts"
  },

Then run the command:

yarn prisma db seed

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

Happy Coding!