Skip to content
/ little-api Public template

A little API to give example of how NestJs works.

Notifications You must be signed in to change notification settings

DevMata/little-api

Repository files navigation

Nest Logo

A little API built with NestJs.

Description

This little API is built around a user crud to give example of common concepts like requests, responses and HTTP methods.

Installation

$ npm install

Before running the app

Check the example.env file to know the required env variables.

# DB
DB_USER=your db user
DB_PASSWORD=your db password
DB_HOST=your db host
DB_PORT=your db port
DB_NAME=your db name

Then create your own .env file and replace the example values.

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

References

Resources for learning

About

A little API to give example of how NestJs works.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published