Skip to content

WesGtoX/prescriptions-api

Repository files navigation

Prescriptions API

About  |   Technology  |   Getting Started  |   Usage  |   Roadmap  |   License

Prescriptions API CI codecov GitHub top language GitHub language count GitHub last commit GitHub issues License

About the Project

Prescription API is a medical prescription service, which inserts new prescriptions and integrates with another service that has four endpoints:

  • [GET] /physicians/:id/: returns the data of a specific physician by its ID.
  • [GET] /clinics/:id/: returns the data of a specific clinic by its ID.
  • [GET] /patients/:id/: returns the data of a specific patient by their ID.
  • [POST] /metrics/: final data integration, where the fetched data will be saved.

Technology

This project was developed with the following technologies:

Getting Started

Prerequisites

Install and Run

  1. Clone the repository:
git clone https://github.com/WesGtoX/prescriptions-api.git
  1. Set the environment variables:
cp .env.sample .env
  1. Run:
make run
  1. Run tests:
make test

Usage

Roadmap

See the open issues for a list of proposed features (and known issues).

License

Distributed under the MIT License. See LICENSE for more information.


Made with ♥ by Wesley Mendes 👋