This project was developed with the following technologies:
- ✔️ Node JS
- ✔️ Express
- ✔️ Sequelize
- ✔️ SQLite3
- ✔️ HTTP Status Codes
- ✔️ Nodemon
- ✔️ Colors
- ✔️ Prettier
- ✔️ Cors
- ✔️ Yup
- ✔️ Swagger
- ✔️ ESLint
- ✔️ AWS
- ✔️ Docker Machine
- ✔️ Docker
- ✔️ 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
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.
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.
npm install or yarn
npm start or yarn start
After the API is started as npm start, go to your favorite browser and go to http://localhost:3333
You can consult the API documentation via the URL http://localhost:3333/api-docs
To test the routes, you can use insomnia and import the routes file (routes-insomnia.json) available in the project's root.
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.
docker-compose up
The API will also be running through port 3333.
MIT © Diego Almeida
Thank you 😘❤️
Diego Almeida.