AlvaroDavi5 / Labs_and_Exams_Management-API

from Alvaro Davi to Wa Project Backend Challenge

Wa Project Challenge - Backend

Install dependencies

To install the dependencies, run the following command:

# after install Yarn package manager
yarn install

---

How run the application in container

To create and run the application in Docker containers, run the following command on the root of the project:

# after install Docker and Docker Compose
docker-compose up -d

---

How to start the application

To start the application, run the following command:

# after install Sequelize
yarn run db_config
# after install Node.js
yarn run dev

After this, access the localhost link.

---

Technologies

• Javascript
• TypeScript
• Node.js
• Express.js
• PostgreSQL
• Sequelize ORM
• Docker
• Docker Compose
• Heroku
• DBDiagram
• API Blueprint

---

TODO

• Database
  • Models
  • Migrations
  • Seeders
  • Documentation
  • Containerization
• Exams Controllers
• Labs Controllers
• ExamLab Controllers
• API
  • Routes
    • Get active entities
    • Find by term in name
    • Create/Delete on all associated registers by lab_id/exam_id
    • Find all labs associated with an exam
  • REST Architecture
  • HTTP Status Codes
  • Documentation
  • Containerization
• Aplication Deployment
• Migrate Code to TypeScript in different releases

---

For more information, visit the docs folder.