Skip to content

Latest commit

 

History

History
72 lines (52 loc) · 2.52 KB

README.md

File metadata and controls

72 lines (52 loc) · 2.52 KB
Raw

E-Comerce REST API NestJS TypeScript JavaScript MongoDB Docker ESLint

home-1 This repository contains a REST API of Sales Store Application with storage to a MongoDB database. Each application service is separated into modules that correspond to their respective domain and also each endpoint is documented using the Open API standard through Swagger.

Table of Contents 📖

  1. Pre-Requirements
  2. Installation
  3. Running the app
  4. HTTP Endpoints
  5. Module Architecture

Pre-Requirements 📋

Installation 🔧

  • Once Docker is installed and running.
$ docker-compose up -d

This will create a container with the mongodb database.

  • Install the necessary dependencies for this project.
$ npm install
  • The repository contains a file called .env.example which shows an example of the environment variables needed to run the application. In the root directory ("/") create an .env file and add the environment variables detailed in the .env.example file.

Running the app 🚀

# development
$ npm run start

# watch mode
$ npm run start:dev

# up mongo database
$ docker-compose up -d mongo

HTTP Endpoints 🖥️

Once the application is running, access the following URI where you will find the documentation for each endpoint and Dto (Data Transfer Object).

/docs

URL example

http://localhost:3000/docs

Module Architecture 📐

Module Diagram