WesGtoX / medicar

Platform for registering and managing medical appointments and schedules.

About  |   Technology  |   Layout  |   Getting Started  |   Usage  |   License

Medicar

Platform for registering and managing medical appointments and schedules.

About the Project

Medicar Back-end

• Administrative system for managing:

  • Medical specialties
  • Doctors
  • Medical agenda
  • Medical appointment

• API Restfull for:

  • Creation:

    • Medical appointment

  • Listing:

    • Medical specialties
    • Doctors
    • Medical agenda
    • Medical appointment

  • Details:

    • Medical specialties
    • Doctors
    • Medical agenda

  • Removal:

    • Medical appointment

Medicar Front-end

• Application login and logout

• List of authenticated user's medical appointments

• Make an appointment for a doctor

• Unmark a doctor's appointment

• Routes:

  Routes	Description
  /login	Login page
  /register	Register a user
  /home	Home page
  /create	Make an appointment

Technology

This project was developed with the following technologies:

• Python
• Django Framework
• Django REST Framework
• Docker
• Docker Compose

Layout

You can view the project layout in the format through this LINK.
Remembering that you will need to have an account at Figma.

Getting Started

Prerequisites

• Python
• Docker
• Docker Compose

Install and Run the API

1. Clone the repository:

git clone https://github.com/WesGtoX/medicar.git

2. Set a SECRET_KEY in .env:

cp backend/.env.sample backend/.env

3. Build

make build

4. Run:

make run

4. Run tests:

make test

Usage

Endpoints

Auth Token

Method	Endpoint	Description
POST	/api-token-auth/	User authentication.

Especialidades

Method	Endpoint	Description
GET	/especialidades/	List all registered specialties.
GET	/especialidades/:id	Show the detail of a specific specialty.

Médicos

Method	Endpoint	Description
GET	/medicos/	List all registered doctors.
GET	/medicos/:id	Show the detail of a specific doctor.

Agendas

Method	Endpoint	Description
GET	/agendas/	List all registered agendas.
GET	/agendas/:id	Show the detail of a specific agenda.

Consultas

Method	Endpoint	Description
POST	/consultas/	Register a medical appointment.
GET	/consultas/	List all registered medical appointment.
DELETE	/consultas/:id	Remove a specific medical appointment.

For more examples, please refer to the Documentation

License

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

---

Made with ♥ by Wesley Mendes 👋