🔗 LibQuality

Project created with For the NodeJS vacancy test at Venturus

🚀 To start the project:

• Clone this repository
• Access the project folder and run the command 'npm install'
• Run this command to start the docker and create the 'sudo docker-compose up -d --build' containers - once this is done, you can access the API via the url "http: // localhost: 8080"

❗IMPORTANT

See how to create a jwt token for personal access on gitHub, it is requested in the request header to get the information from the repository

(https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token)

🗒️ To see swagger docs:

• http://localhost:8080/api-docs/

💻 Technologies used

• NodeJS
• MongoDB 3.6.5

🗄️ Project Structure

├── src/ ───────────────────────────── API Source
│ ├── controllers/ ───────────────── API Controllers
│ ├── models/ ────────────────────── MySQL models
│ ├── services/ ──────────────────── External functions and helpers
│ ├── app.ts ───────────────────── App file
│ ├── index.ts ───────────────────── Main file
│ ├── routes.ts ───────────────────── Router file
├── docker-compose.yml ─────────────── Docker Compose file
├── Dockerfile ─────────────────── Docker config file
├── README.md