StudFit API

API back-end para gerenciamento da academia do IFCE campus Cedro, contemplando cadastro de alunos, autenticação via JWT, controle de presenças, horários e integração com serviços da AWS. A aplicação permite que usuários gerenciem alunos, realizem upload de atestados, controlem frequências e exportem dados, garantindo segurança, rastreabilidade e escalabilidade.

Índice

1. Tecnologias Utilizadas
2. Funcionalidades
3. Pré-requisitos
4. Configurações Iniciais
5. Executando a API
6. Documentação

Tecnologias Utilizadas

Funcionalidades

🔐 Autenticação e Segurança

• Login com JWT - Autenticação segura com geração de token de acesso
• Recuperação de senha - Envio de código de recuperação de 6 dígitos por e-mail
• Redefinição de senha - Atualização de senha através do código de recuperação
• Validação de token - Verificação de validade e assinatura do token JWT

👤 Gestão de Usuários

• Cadastro de usuários - Registro de administradores, estagiários e instrutores
• Listagem de usuários - Visualização de todos os usuários cadastrados
• Exclusão de usuários - Remoção de usuários do sistema (com controle de permissões)

🎓 Gestão de Alunos

• Lista de espera - Registro e gerenciamento de alunos aguardando efetivação
• Efetivação de alunos - Processo de efetivação de alunos da lista de espera
• Consulta de alunos - Busca por ID, turno e status (efetivados e lista de espera)
• Atualização de dados - Edição de informações cadastrais dos alunos
• Exclusão de alunos - Remoção de alunos da lista de espera ou efetivados
• Upload de atestados - Anexação de atestados médicos em PDF (integração com AWS S3)

📅 Gestão de Horários

• Cadastro de horários - Criação de horários por turno (Manhã, Tarde, Noite)
• Listagem de horários - Visualização de todos os horários ou filtrados por turno
• Exclusão de horários - Remoção de horários (com validação de alunos vinculados)

✅ Controle de Presenças

• Registro de presenças - Marcação de presença de múltiplos alunos por data
• Consulta de presenças - Listagem paginada de todas as presenças
• Filtro por data - Busca de presenças por data específica

📧 Notificações por E-mail

• Confirmação de efetivação - E-mail automático ao efetivar aluno
• Recuperação de senha - E-mail com código de recuperação
• Notificação de remoção - E-mail informando remoção do sistema
• Alerta de faltas - Notificação automática por excesso de faltas

Pré-requisitos

Para executar este projeto, você precisará ter instalado:

• Git - Para clonar o repositório
• Java 17 ou superior
• Maven 3.6+ - Para gerenciar dependências
• Docker e Docker Compose (Opcional, mas recomendado)
• PostgreSQL (caso não use Docker)
• Redis (caso não use Docker)

Configurações Iniciais

1. Clonando o Repositório

Clone o repositório executando o seguinte comando no terminal:

git clone https://github.com/deiz0n/StudFit-API
cd StudFit-API

2. Configurando as Variáveis de Ambiente

Crie um arquivo .env com base no arquivo .env.example e preencha com suas credenciais

⚠️ IMPORTANTE:

• As portas 5432 para o PostgreSQL e 587 para servidor SMTP devem está disponíveis
• Todas as credenciais informadas são confidenciais e serão utilizadas apenas para o funcionamento da aplicação
• Certifique-se de preencher todos os campos obrigatórios para garantir o correto funcionamento da API

3. Instalando as Dependências

Se você não estiver usando Docker, instale as dependências do projeto executando:

mvn clean install

Executando a API

Opção 1: Executando com Docker Compose (Recomendado)

Esta opção iniciará automaticamente o banco de dados PostgreSQL, Redis e a aplicação:

docker-compose up --build

A API estará disponível em: http://localhost:80

Para parar os containers:

docker-compose down

Opção 2: Executando Localmente

Certifique-se de que o PostgreSQL e Redis estão rodando localmente, então execute:

mvn spring-boot:run

Ou, após buildar o projeto:

java -jar target/studfit-0.0.1-SNAPSHOT.jar

A API estará disponível em: http://localhost:{API_PORT}

Opção 3: Executando apenas com Docker

Construa a imagem Docker:

docker build -t studfit-api .

Execute o container:

docker run --env-file .env -p 8080:8080 studfit-api

Documentação

1. Diagrama lógico do banco de dados

2. Diagrama atual na AWS

3. Arquitetura atual da API

4. Possível arquitetura futura

Para melhor visualização dos diagramas, acesse: clique aqui

5. Rotas da aplicação

A API possui documentação interativa gerada automaticamente com Swagger/OpenAPI.

Após iniciar a aplicação, acesse:

http://localhost:{API_PORT}/swagger-studfit.html

Ou para acessar a especificação JSON da API:

http://localhost:{API_PORT}/v3/api-docs

Estrutura do Projeto

src/
├── main/
│   ├── java/com/deiz0n/studfit/
│   │   ├── controllers/          # Controladores REST
│   │   ├── domain/                # Entidades, DTOs, Enums
│   │   ├── infrastructure/        # Configurações, Segurança, Repositórios
│   │   ├── services/              # Lógica de negócio
│   │   └── StudfitApplication.java
│   └── resources/
│       ├── application.properties
│       ├── db/migration/          # Scripts Flyway
│       └── templates/             # Templates de e-mail
└── test/
    └── java/com/deiz0n/studfit/
        ├── integration/           # Testes de integração
        └── unit/                  # Testes unitários

Suporte

Para problemas, dúvidas ou sugestões, abra uma issue no repositório do projeto.

---