Marketplace API

Description

Nest framework TypeScript starter repository.

Local Development

Devcontainer allows you to run containerised from within VSCode. This is the recommended way to run the project.

VSCode

Install the Remote Development extension pack.

Docker

Install Docker

Devcontainer

Open the project in VSCode and click on the green button in the bottom left corner. Select Reopen in Container.

This will build the devcontainer and install dependencies.

To start the project, open a terminal within VSCode and run:

npm run start:dev

You can now access the API via your local browser at http://localhost:3005/docs

Database

The devcontainer comes with a running postgres instance.

Connect to the local Postgres Database within terminal:

psql -h db -U postgres postgres

password is postgres

Manual Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov