eduardoluizdev / sales-api

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

API to Sales

This project aims to improve my skills in the back-end from a need to create an API for sales, using Design Patterns, Domain Driven Design (DDD) and SOLID Principles, Docker with Docker Compose in addition to introducing Automated Tests with the framework Jest.

Dependencies

To run this script you need to install locally on your machine the following dependencies:

  • Node.js;
  • Express;
  • Typescript;
  • ESLint;
  • Prettier;
  • Jest;
  • Celebrate;
  • Multer;
  • CORS;
  • JWT;
  • BCrypt;
  • Nodemailer;
  • Handlebars;
  • Postgres;
  • Redis;
  • TypeORM;
  • Docker;
  • Docker Compose;

Running

  1. Open project folder and run docker-compose up;
  2. In terminal: cd /src/config and execute cp auth.exemple.ts auth.ts; 2.2 Read the instructions at the auth.tsand fill in what is needed;

Endpoints

  • Products - http://localhost:3333/products
  • Users - http://localhost:3333/users
  • Sessions - http://localhost:3333/sessions
  • Forgot Password - http://localhost:3333/password/forgot
  • Reset Password - http://localhost:3333/password/reset
  • Profile - http://localhost:3333/profile

Features

  • Docker / Docker Compose
  • Postgres
  • TypeORM
  • Product Module
  • User Module
  • Profile Module
  • Authentication Module
  • User password management
  • User profile management
  • Customer Module
  • Purchase orders Module
  • Redis
  • Refactor DDD/SOLID
  • Tests

About


Languages

Language:TypeScript 98.1%Language:Handlebars 0.6%Language:Shell 0.6%Language:JavaScript 0.6%Language:Dockerfile 0.1%