Skip to content

Latest commit

 

History

History
84 lines (60 loc) · 1.64 KB

README.md

File metadata and controls

84 lines (60 loc) · 1.64 KB
Raw

Nest Logo

NestJS Contacts API

This project uses @nestjsx/crud to simplify and standardize the REST API

This backend is based on NestJS Framework V6 (https://nestjs.com/)

  • DB: Postgres
  • Websockets: Socket.io
  • Synchronises sockets thourgh Redis adapter for horizontal scaling

Frontend is available here: https://github.com/avatsaev/angular-contacts-app-example

Env VARS:

  SERVER_PORT: 3000
  POSTGRES_HOST: db
  POSTGRES_PORT: 5432
  POSTGRES_USER: contacts_db
  POSTGRES_PASSWORD: contacts_db_pass
  POSTGRES_DB: contacts_db
  REDIS_HOST: redis
  REDIS_PORT: 6379
  REDIS_ENABLED: 'true'

Run

docker-compose up --build

Server will be running on http://localhost:3000

Endpoints

  • GET /contacts : returns an array of Contacts
  • GET /contacts/:id: returns a Contact shape
  • POST /contacts: Create a contact, returns a Contact shape
  • PATCH /contacts/:id: Partially update a Contact, returns a Contact shape
  • DELETE /contacts/:id: Delete a Contact, empty response

Contact shape:

interface Contact {
    id?: number | string;
    name: string;
    email: string;
    phone?: string;
}

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