Description | Prerequisites | Running | Endpoints | Principles | Design Patterns | Methodologies & Designs | Libraries and Frameworks

---

Description

Restful API developed using Node.js and express framework

---

Prerequisites

• Git, Docker and Docker-Compose installed.

---

Running the project

All commands below are done in the terminal

1 - Clone the repository and access the directory created by the clone:

https://github.com/JosineyJr/PipeDrive-Bling-Integration-API && cd PipeDrive-Bling-Integration-API

2 - Start the application:

make start-app

---

Endpoints

1. POST api/login
   • Authenticate the user.
2. POST api/integration
   • Executes the integration.
3. GET api/collections/pedidos
   • Retrieves consolidated data from MongoDB collection.

---

Principles

• Single Responsibility Principle (SRP)
• Open Closed Principle (OCP)
• Liskov Substitution Principle (LSP)
• Interface Segregation Principle (ISP)
• Dependency Inversion Principle (DIP)
• Separation of Concerns (SOC)
• Don't Repeat Yourself (DRY)
• You Aren't Gonna Need It (YAGNI)
• Keep It Simple, Silly (KISS)
• Composition Over Inheritance

---

Design Patterns

• Factory
• Adapter
• Composite
• Decorator
• Proxy
• Dependency Injection
• Abstract Server
• Composition Root
• Builder
• Singleton

---

Methodologies and Designs

• Clean Architecture
• DDD
• Modular Design
• Use Cases

---

Libraries and Frameworks

• NPM
• Typescript
• Git
• Docker
• MongoDb
• Postgres
• Bcrypt
• JsonWebToken
• Validator
• Express
• Axios
• Eslint
• Rimraf
• Redis
• Bull
• Fast xml parser