Plataforma de cadastro de ONGs, eventos, voluntários e doações.

O Altrua é uma plataforma REST que conecta Organizações Não Governamentais (ONGs) a voluntários e doadores. As ONGs podem se cadastrar e publicar eventos, enquanto usuários podem se inscrever como voluntários ou acessar informações sobre como contribuir com doações.

Projeto desenvolvido como Projeto Integrador do curso — utilizando uma stack moderna com Java 21, Spring Boot, JPA, PostgreSQL e Docker.

• ✅ Cadastro e autenticação de ONGs e usuários
• ✅ Criação e gerenciamento de eventos por ONGs
• ✅ Inscrição de voluntários em eventos
• ✅ Informações sobre doações por evento/ONG
• ✅ Listagem e busca de ONGs e eventos
• ✅ API REST documentada

altrua/
├── src/
│   ├── main/
│   │   ├── java/com/techfun/altrua/
│   │   │   ├── controller/      # Endpoints REST
│   │   │   ├── service/         # Regras de negócio
│   │   │   ├── repository/      # Acesso ao banco (JPA)
│   │   │   ├── model/           # Entidades JPA
│   │   │   ├── dto/             # Objetos de transferência
│   │   │   └── AltruaApplication.java
│   │   └── resources/
│   │       ├── application.properties
│   │       └── db/migration/    # Scripts Flyway (V1__*.sql, V2__*.sql ...)
│   └── test/
│       └── java/com/techfun/altrua/
│           └── AltruaApplicationTests.java
├── docker-compose.yaml
├── Makefile
├── pom.xml
└── README.md

• Docker e Docker Compose
• Java 21
• Make

git clone https://github.com/mateusfg7/altrua.git
cd altrua

make setup

Esse comando cria o arquivo .env a partir do .env.example. Abra o .env e preencha as credenciais antes de continuar.

make dev

Esse comando sobe o banco de dados via Docker e inicia a aplicação. As migrations do Flyway são executadas automaticamente na inicialização.

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

Copie o .env.example e preencha os valores:

cp .env.example .env

O application.properties lê essas variáveis automaticamente via ${VAR}:

spring.datasource.url=jdbc:postgresql://localhost:5432/${DB_NAME}
spring.datasource.username=${DB_USER}
spring.datasource.password=${DB_PASSWORD}

⚠️ Nunca commite o .env com credenciais reais. Ele já está no .gitignore.

make help        # Lista todos os comandos disponíveis
make setup       # Configura o projeto (cria o .env a partir do .env.example)
make dev         # Sobe o banco e inicia a aplicação
make run         # Inicia apenas a aplicação
make build       # Compila o projeto (sem rodar os testes)
make test        # Executa os testes automatizados
make clean       # Remove arquivos de build
make docker-up   # Sobe os containers em background
make docker-down # Para e remove os containers
make logs        # Exibe os logs do PostgreSQL em tempo real

O docker-compose.yaml sobe apenas o banco de dados para desenvolvimento local:

services:
  postgres:
    image: postgres:16
    ports:
      - "5432:5432"
    environment:
      POSTGRES_DB: ${DB_NAME}
      POSTGRES_USER: ${DB_USER}
      POSTGRES_PASSWORD: ${DB_PASSWORD}
    volumes:
      - pgdata:/var/lib/postgresql/data

volumes:
  pgdata:

A API REST está em desenvolvimento. A documentação dos endpoints será adicionada assim que os controllers forem implementados.

Este projeto está sob a licença GPL-3.0.