/pluto-nestjs

Primary LanguageTypeScript

Nest Logo

Description

This is a test API project for pluto project. The API was designed and inspired by a free template named Pluto found here

Documentation

The documentation is available on Postman documentation

  • Take note of the examples on the right darker section that can show you example response data for different queries.
  • The users listing is left unguarded with auth guards so you have access to the users you can use for the tinkering.

Installation

This project can be run on docker but first you will need to make a local copy of the environment file.

cp .env.example .env

Next you will need to run the project via docker compose. This will setup your DB and start the API backend.

docker-compose up

Open another terminal tab and migrate and seed the database so you can have data to toy around with. All users created here have the password of secret

docker exec -it backend npm run migrate:seed

That is pretty much it. The backend will be available on:

http://localhost:3000