challenge-mm

MaxMilhas Challenge

API for CPF consultation, validation and inclusion of mask, among other resources for learning.

Table of contents

• Quick start
• Setup
• Structure of the project
• Bugs and feature requests
• Documentation
• Contributing
• Creators

Quick start

Several quick start options are available:

• Download the latest release.
• Clone the repo: git clone https://github.com/danielgalleni/challenge-mm.git
• Install with npm: npm install
• Install Docker following this link

Structure of the project

Within the download you'll find the following directories and files, logically grouping common assets. You'll see something like this:

challenge-mm/
├── config/
│   ├── custom-express.js
│   ├── global-setting.js
└── resources/
│   ├── controllers/
│   |   ├── cpfs-controller.js
|   ├── models/
│   |   ├── cpfs-models.js
|   ├── routes/
│       ├── cpfs-routes.js
└─── test
|   ├── test.js
├── .dockerignore
├── .gitignore
├── Dockerfile
├── package-lock.json
├── package.json
├── README.me
├── routes.js
├── service.js

Setup

• Create/build the container sudo docker build -t danielgalleni/challenge-mm .
• Execute this command sudo docker run -it -p 8080:3001 -d danielgalleni/challenge-mm

Bugs and feature requests

• To fix bugs and suggest improvements in the project, just fork the same and send a pull request. Your name and link to github will include in this README.

Documentation

• Routes the API

GET

• /
• /Ping
• /Status
• /cpfs
• /cpfs/:cpfId
• /cpfs/list/block
• /cpfs/list/free
• /status/:cpf

POST

• /cpfs

PUT

• /cpfs/:cpfId
• /cpfs/:cpf/block
• /cpfs/:cpf/free

DELETE

• /cpfs/:cpfId

Creators

• Daniel Galleni