silasstoffel / clear-sale-api

Customer API

Backend technical challenge from Clear Sale.

Requirements

• Docker
• Docker Compose
• Node v18.17
• MongoDB v6

About

This project has the propose to create a simple RestFULL API with the CRUD operations.

Setup

Install dependencies:

# it's necessary (required)
npm i

Helper to setup up your environment:

# linux/macOs
$ sh ./scripts/shell.sh

# or
$ sh ./scripts/dev.sh #show real-time log (nodemon)

http://localhost:8000/health-check

API Reference

Swagger

Tests

Execute the following commands:

# accessing node container
$ sh ./scripts/shell.sh

# run test
npm run test

# test with coverage report
npm run test:coverage

Techs

This project was created using the following principle and techniques:

• Clean Architecture
• SOLID
• RESTful
• Object Calisthenics
• Repositories
• Tests
• GitHub Actions (Build, Test and code analyses)
• Sonar Cloud