NestJS codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the RealWorld spec and API.

Demo    RealWorld

This codebase was created to demonstrate a fully fledged fullstack application built with NestJs including CRUD operations, authentication, routing, pagination, and more.

We've gone to great lengths to adhere to the NestJs community styleguides & best practices.

For more information on how to this works with other frontends/backends, head over to the RealWorld repo.

Installation

To install the application:

npm ci

To start the local database and run the migrations:

npm run compose:up
# or manually
docker compose up --remove-orphans -d

To stop the local database:

npm run compose:down
# or manually
docker compose down --remove-orphans

To completely reset the docker containers (this will delete container volumes):

npm run compose:destroy
# or manually
docker compose down --rmi local --remove-orphans -v

Another way to reset the database is to run the refresh command:

npm run compose:refresh
# or manually
npm run compose:destroy && npm run compose:up

Running the app

# development
npm start

# watch mode
npm run start:dev

# production mode
npm run start:prod

Local development

Once the containers and the app are running, you can access the following services:

Backend:

• localhost:3001/swagger for API docs

Docker services:

• localhost:25000 for redis insight cacheDb (requires setup)
• localhost:25001 for pgweb cockroachdb devDb
• localhost:25002 for pgweb postgres testDb
• localhost:25003 for dbeaver clickhouse logDb (requires setup)
• localhost:18080 for cockroachdb manager

How to set-up redis insight:

How to set-up clickhouse:

Test

# unit tests
npm test

# e2e tests
npm run test:e2e

# test coverage
npm run test:cov

License

Nest is MIT licensed.