doc: implement README

master
Artur Oliveira 2025-12-15 20:17:59 -03:00
parent 9e44e365ab
commit 6145597d8c
1 changed files with 38 additions and 0 deletions

38
README.md 100644
View File

@ -0,0 +1,38 @@
# Hit Server Manager
Plataforma interna da Hit Communications para catalogar os servidores corporativos e expor essas informações de forma rápida ao time de Análise de Sistemas e Desenvolvimento. O backend centraliza cadastros, contexto técnico (tipo, aplicação e banco) e credenciais operacionais, facilitando consultas padronizadas e mantendo histórico de alterações.
## Principais recursos
- CRUD completo de usuários internos e servidores
- Validação de domínio corporativo para criação de usuários
- Mapeamentos DTO ↔ entidades com MapStruct
- API REST documentada via coleção Postman (`postman_collection.json`)
- Persistência em H2 (memória/disco) com Spring Data JPA e geração automática de IDs personalizados para servidores
## Stack
- Java 21 + Spring Boot 4.0
- Spring Web MVC, Validation, Data JPA
- H2 Database
- MapStruct 1.6
- Lombok
- Spring Security (JWT em breve)
- Docker Compose para orquestração local
- ReactJS
## Como rodar
1. **Pré-requisitos**: JDK 21 e acesso ao Gradle Wrapper (`./gradlew`).
2. **Instalar dependências e rodar testes**:
```bash
./gradlew clean test
```
3. **Subir o backend**:
```bash
./gradlew bootRun
```
4. A API ficará disponível em `http://localhost:8080`. Utilize a coleção Postman incluída para exercitar os endpoints de `Users` e `Servers` (`{{base_url}}` já configurado com esse endereço).
## Próximos passos
- [ ] Substituir H2 por PostgreSQL para persistência
- [ ] Proteger os endpoints com autenticação (Spring Security com JWT)
- [ ] Criar o frontend React integrado ao backend
- [ ] Containerizar backend + frontend com Docker Compose