/examination-laboratory-api

API developed in the WA Project company test exam.

Primary LanguageJavaScript

Author

Examination Laboratory API

API developed in the WA Project company test exam..


WA Project

📑 Technologies and modules used

This project was developed with the following technologies:


📍 Features

  • ✔️ Register laboratory
  • ✔️ Register laboratory batch
  • ✔️ List of laboratories
  • ✔️ Update laboratory
  • ✔️ Update laboratory batch
  • ✔️ Remove laboratory
  • ✔️ Remove laboratory batch
  • ✔️ Associate exam with a laboratory
  • ✔️ Disassociates exam of a laboratory
  • ✔️ Register exam
  • ✔️ Register exam batch
  • ✔️ Exam list
  • ✔️ List all laboratories for a given exam
  • ✔️ Update exam
  • ✔️ Update exam batch
  • ✔️ Remove exam
  • ✔️ Remove exam batch

🚀 Getting Started

You can run this project on your machine, but for that you need to have installed Git in addition to NodeJS with npm or yarn.

So first you need to make a git clone of the repository.

💻 Clone the repository

git clone https://github.com/dyhalmeida/examination-laboratory-api

After git clone, go to the cloned repository on your computer and run the npm install command so that the project's dependencies are installed.

💻 Installation

npm install or yarn

💻 Start Project

npm start or yarn start

After the API is started as npm start, go to your favorite browser and go to http://localhost:3333


📑 API Docs

You can consult the API documentation via the URL http://localhost:3333/api-docs


📑 Insomnia

To test the routes, you can use insomnia and import the routes file (routes-insomnia.json) available in the project's root.


📑 Run this project through Docker

This project can be run through the Docker as well and for that it is necessary to have Docker and Docker Compose installed on your machine.

💻 Run now

docker-compose up

The API will also be running through port 3333.


🔓 License

MIT © Diego Almeida


Thank you 😘❤️
Diego Almeida.