nestjs-example

(β˜… 402)

NestJS example with using GraphQL (schema stitching, schema reload, dataloader, upload files, subscriptions, response cache), RabbitMQ, Redis, Websocket, JWT authentication, ESLint 9

  • .dockerignore
  • .gitignore
  • .tool-versions
  • docker-compose.yml
  • Dockerfile
  • eslint.config.cjs
  • LICENSE.md
  • nginx.conf
  • nodemon.json
  • package-lock.json
  • package.json
  • prettier.config.cjs
  • README.md
  • tsconfig.build.json
  • tsconfig.json

# Installation Guide

1. Get the code
git clone https://github.com/tkosminov/nestjs-example

Downloads the entire project code from GitHub to your computer.

cd nestjs-example

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
sudo docker build -t nestjs-example . --build-arg env=development

Builds a runnable image based on the Dockerfile.

sudo docker run -d --network host nestjs-example:latest

Runs the built image as an actual container.

sudo docker ps -a | grep nestjs-example

Type this command into your terminal and run it.

sudo docker exec -it $CONTAINER_ID sh

Type this command into your terminal and run it.

sudo docker logs $CONTAINER_ID

Type this command into your terminal and run it.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm ci

Type this command into your terminal and run it.

npm run start:dev

Starts the development/run server.

npm run repl:dev

Type this command into your terminal and run it.

npm run madge:full

Type this command into your terminal and run it.

npm run madge:circular

Type this command into your terminal and run it.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation