TaskManager API

Este projeto é uma API RESTful construída com Spring Boot 3.5 e Java 17 para gerenciamento de tarefas com workspaces, boards, listas e cards — inspirado em ferramentas como o Trello.

Pré-requisitos

Certifique-se de ter os seguintes itens instalados:

• Java 17 (JDK)
• Maven 3.9+ (ou utilize o wrapper mvnw incluído)
• Docker & Docker Compose (para serviços de infraestrutura)
• PostgreSQL 16 (se executar sem Docker)
• Redis 7 (se executar sem Docker)

Primeiros Passos

1. Clonar o repositório

git clone https://github.com/jonasmessias/task-manager-api.git
cd task-manager-api

2. Configurar variáveis de ambiente

Copie o arquivo de propriedades de exemplo e preencha com seus valores:

cp src/main/resources/application-example.properties src/main/resources/application.properties

Atualize as seguintes propriedades em application.properties:

Propriedade	Descrição
api.security.token.secret	Chave forte e aleatória para assinar JWTs
aws.ses.access-key	Chave de acesso AWS SES
aws.ses.secret-key	Chave secreta AWS SES
aws.ses.from	E-mail de remetente verificado no AWS SES
aws.s3.access-key	Chave de acesso AWS S3
aws.s3.secret-key	Chave secreta AWS S3
aws.s3.bucket-name	Nome do bucket S3 para armazenamento
aws.s3.region	Região AWS do bucket S3
google.client-id	Client ID do Google OAuth 2.0
app.frontend.url	URL do frontend para CORS (desenvolvimento)
app.frontend.prod-url	URL do frontend para CORS (produção)

3. Iniciar infraestrutura com Docker Compose

docker compose up -d postgres redis

Isso inicia o PostgreSQL na porta 5432 e o Redis na porta 6379.

4. Executar a aplicação

./mvnw spring-boot:run

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

Executando com Docker (stack completa)

Para executar a stack completa (API + PostgreSQL + Redis) em containers:

docker compose up -d --build

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

Deploy em Produção

Infraestrutura

A aplicação roda em produção na AWS com a seguinte arquitetura:

┌─── EC2 (Docker Compose) ────────┐
│                                  │
│  ┌────────────────────────────┐  │
│  │  Redis 7 (container)       │  │
│  └──────────┬─────────────────┘  │
│             │ rede interna        │
│  ┌──────────┴─────────────────┐  │
│  │  Spring Boot (container)   │  │
│  │  porta 8080                │  │
│  └────────────────────────────┘  │
│                                  │
│  Nginx (reverse proxy + SSL)     │
│  porta 80/443 → 8080            │
│                                  │
└──────────────┬───────────────────┘
               │ rede VPC
        ┌──────┴──────┐
        │  AWS RDS     │
        │  PostgreSQL  │
        └─────────────┘

Serviço	Tecnologia	Descrição
Servidor	AWS EC2	Hospeda API + Redis via Docker
Banco	AWS RDS PostgreSQL 16	Banco de dados gerenciado
Cache	Redis 7 (Docker local)	Refresh tokens (dentro da EC2)
Email	AWS SES	E-mails transacionais
Storage	AWS S3	Armazenamento de arquivos
SSL	Nginx + Certbot	HTTPS com Let's Encrypt
CI/CD	GitHub Actions	Deploy automático a cada push

CI/CD (Deploy Automático)

A cada push na branch master, o GitHub Actions conecta via SSH na EC2 e executa:

git pull → docker compose build → deploy

O workflow está em .github/workflows/deploy.yml e requer os seguintes Secrets no repositório:

Secret	Descrição
EC2_HOST	IP público da instância EC2
EC2_USERNAME	Usuário SSH (ex: ec2-user)
EC2_SSH_KEY	Conteúdo do arquivo .pem

Configuração de Produção

A aplicação usa Spring Profiles. Em produção, o profile prod é ativado via variável de ambiente SPRING_PROFILES_ACTIVE=prod, que carrega o arquivo application-prod.properties.

Todas as credenciais são injetadas via variáveis de ambiente definidas em um arquivo .env na EC2 (não versionado no git).

Documentação da API

Com o servidor em execução, abra o navegador e acesse:

http://localhost:8080/swagger-ui.html

A interface interativa do Swagger UI permite explorar e testar todos os endpoints disponíveis.

Nota: O Swagger UI é desabilitado em produção por segurança.

Estrutura do Projeto

src/main/java/com/example/taskmanagerapi/
├── config/              # Configuração OpenAPI, Redis, AWS SES, AWS S3
├── infra/
│   ├── cors/            # Política de CORS
│   ├── exception/       # Tratamento global de exceções (custom exceptions)
│   └── security/        # Filtro JWT, Rate Limiting, serviço de token, configuração
└── modules/
    ├── auth/            # Autenticação, usuários, verificação de e-mail
    ├── workspaces/      # CRUD de Workspaces + membros + capas
    ├── boards/          # CRUD de Boards + membros + capas
    ├── lists/           # CRUD de Listas (colunas)
    ├── cards/           # CRUD de Cards + drag-and-drop + anexos
    └── storage/         # Upload de arquivos AWS S3 (direto + URLs pré-assinadas)

Stack Tecnológica

Tecnologia	Finalidade
Java 17	Linguagem
Spring Boot 3.5	Framework
Spring Security	Autenticação e autorização
JWT (java-jwt)	Token de acesso (expiração de 4h)
PostgreSQL 16	Banco de dados principal
Redis 7	Cache de refresh tokens (TTL de 7 dias)
Flyway	Migrações de banco de dados
Bucket4j	Rate limiting por IP
Spring Actuator	Health check e métricas
AWS SES	E-mails transacionais (HTML)
AWS S3	Armazenamento de arquivos (avatares, capas)
Google OAuth 2.0	Login social
Thymeleaf	Templates de e-mail HTML
Springdoc OpenAPI	Documentação Swagger UI
Docker Compose	Containerização da infraestrutura
GitHub Actions	CI/CD — deploy automático
Nginx + Certbot	Reverse proxy + HTTPS (Let's Encrypt)
Lombok	Redução de boilerplate

Executando Testes

Para executar os testes unitários, utilize o seguinte comando:

./mvnw test

Build

Para compilar o projeto e gerar o artefato .jar:

./mvnw clean package -DskipTests

O JAR compilado será armazenado em target/task-manager-api-1.0.0.jar.

Saiba Mais

Para mais detalhes sobre a arquitetura, fluxo de autenticação, endpoints e regras de negócio, consulte o arquivo DOCUMENTATION.md.