sheygs/contact-manager-backend

contact-manager-backend

API service that allows authenticated users to save contact information

Features

Tech Stack

• TypeScript
• Node.js
• PostgreSQL
• Jest

Requirements

• Docker
• Postman
• Git

Rename.env.dev to .env and populate variables

PORT=3000
NODE_ENV=development
PG_PASSWORD=****
PG_PORT=5432
PG_HOST=postgres
PG_USER=postgres
PG_DATABASE=****
JWT_SECRET=****
JWT_EXPIRES_IN=*d
JWT_COOKIE_EXPIRES_IN=*

Installation 📦

   $ git clone https://github.com/sheygs/contact-manager-backend.git
   $ cd contact-manager-backend
   $ yarn

Using Docker (Recommended)

• Run docker-compose up -d.
• Open browser and visit http://localhost:3001

Without Docker

• Run yarn start:dev to run the service.
• Open browser and visit http://localhost:3001

Test

   $ npm test

Postman Documentation

• Please see /postman_docs directory on the root OR
• Navigate to http://localhost:3001/api-docs on your computer to view the openapi documentation.

Improvement Points

• Implement Caching for frequently accessed data
• Implement Pagination for large data sets