nestjs-cqrs-saga

(β˜… 116)

Nestjs application with CQRS pattern and SAGA

  • .gitignore
  • docker-compose.yml
  • LICENSE
  • nest-cli.json
  • nodemon-debug.json
  • nodemon.json
  • package.json
  • README.md
  • tsconfig.build.json
  • tsconfig.json
  • tslint.json
  • yarn.lock

# Installation Guide

1. Get the code
git clone https://github.com/amehat/nestjs-cqrs-saga

Downloads the entire project code from GitHub to your computer.

cd nestjs-cqrs-saga

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.
$ docker-compose up

Runs the command against the services defined in the compose file.

$ docker-compose down

Runs the command against the services defined in the compose file.

βœ… 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 install

Downloads and installs the libraries listed in package.json.

$ npm run start

Starts the development/run server.

$ npm run start:dev

Starts the development/run server.

$ npm run start:prod

Starts the development/run server.

$ npm run test

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