Skip to content

Latest commit

 

History

History
144 lines (97 loc) · 4.31 KB

README.md

File metadata and controls

144 lines (97 loc) · 4.31 KB
Raw

Spring Boot Logo


Voll.med

Voll.med é uma API REST desenvolvida em Java utilizando o Spring Boot, com o objetivo de fornecer uma solução backend para o gerenciamento de consultas médicas. Esse projeto permite agendar consultas, verificar horários disponíveis, entre outros. A API está organizada em diferentes rotas que oferecem funcionalidades para o sistema de gestão de consultas.

O objetivo deste projeto é aplicar e aprimorar conhecimentos em Java e desenvolver melhores práticas na construção de APIs RESTful.

Funcionalidades Principais

  • Cadastro e Gerenciamento de Médicos e Pacientes: Rotas para cadastrar, atualizar e excluir informações.
  • Agendamento de Consultas: Interface para agendar e verificar a disponibilidade de horários.
  • Cancelamento de Consultas: Cancelar consultas agendadas.

Tecnologias Utilizadas

  • Java: Linguagem principal para o desenvolvimento da API.
  • MySQL: Banco de Dados relacional utilizado.
  • Spring Boot: Framework para criação de APIs RESTful.
  • Spring Data JPA: Para integração com o banco de dados.
  • Spring Validation: Para validar a entrada de dados.
  • Flyway: Para gerar migrações.
  • JWT Token: Para gerar e validar token.

Estrutura do Projeto

O projeto segue uma estrutura organizada de acordo com as boas práticas de desenvolvimento em Spring Boot. Abaixo estão os principais pacotes:

  • controller: Controladores das rotas.
  • domain: Lógica de negócio da aplicação.
  • infra: Configurações de segurança e outras personalizações.

Como Rodar o Projeto Localmente

Pré-requisitos

  • Java 17
  • Maven

Passos para executar

  1. Clone o repositório: 
    git clone https://github.com/seu-usuario/voll-med-api.git
  2. Entre no diretório do projeto: 
    cd voll-med-api
  3. Execute o projeto com o Maven: 
    ./mvnw spring-boot:run

Melhorias Futuras

  • Implementação de autenticação OAuth2.
  • Integração com um banco de dados em produção.
  • Implementação de testes unitários e de integração.
  • Implementação do swagger.

Spring Boot Logo


Voll.med

Voll.med is a REST API built in Java using Spring Boot to provide a backend solution for managing medical appointments. This project enables scheduling appointments, checking available time slots, among other features. The API is organized into various routes that offer comprehensive functionality for a consultation management system.

This project aims to apply and enhance Java skills and develop best practices in RESTful API design.

Main Features

  • Doctor and Patient Management: Routes for registering, updating, and deleting information.
  • Appointment Scheduling: Interface to schedule and check the availability of time slots.
  • Appointment Cancellation: Cancel scheduled appointments.

Technologies Used

  • Java: Primary language for API development.
  • MySQL: Database used in this project.
  • Spring Boot: Framework for building RESTful APIs.
  • Spring Data JPA: For database integration.
  • Spring Validation: For data validation.
  • Flyway: Generate migrations.
  • JWT Token: Generate and read tokens.

Project Structure

The project follows an organized structure according to best practices in Spring Boot development. Below are the main packages:

  • controller: Route controllers.
  • domain: Application business logic, data access interfaces, and others.
  • infra: Security settings and other customizations.

How to Run the Project Locally

Prerequisites

  • Java 17
  • Maven

Steps to Run

  1. Clone the repository: 
    git clone https://github.com/your-username/voll-med-api.git
  2. Enter the project directory: 
    cd voll-med-api
  3. Run the project with Maven: 
    ./mvnw spring-boot:run

Future Improvements

  • Implement OAuth2 authentication.
  • Integrate with a production database.
  • Implement unit and integration tests.
  • Implement swagger.