104 lines
2.5 KiB
Markdown
104 lines
2.5 KiB
Markdown
# 🐴 GoHorse Jobs
|
|
|
|
Plataforma de recrutamento com arquitetura separada por serviços:
|
|
|
|
- **Frontend**: Next.js (portal de vagas e dashboards).
|
|
- **Backend**: API em Go (regras de negócio, autenticação, dados).
|
|
- **Backoffice**: NestJS (administração, operações e integrações).
|
|
- **Seeder API**: utilitários para carga de dados de desenvolvimento.
|
|
|
|
---
|
|
|
|
## ✅ Estado atual da documentação
|
|
|
|
Este repositório tinha documentação duplicada e com partes desatualizadas. A partir desta revisão:
|
|
|
|
- a **fonte canônica** de documentação geral passa a ser a pasta [`docs/`](docs/);
|
|
- arquivos antigos na raiz (ex.: `ROADMAP.md`, `STATUS_REPORT.md`) foram reduzidos para ponteiros;
|
|
- o roadmap foi simplificado para refletir prioridades reais do produto (sem backlog histórico de iniciativas fora de escopo atual).
|
|
|
|
---
|
|
|
|
## 📚 Onde encontrar cada assunto
|
|
|
|
### Documentação central (canônica)
|
|
|
|
- [docs/API.md](docs/API.md) — endpoints, contratos e exemplos.
|
|
- [docs/API_SECURITY.md](docs/API_SECURITY.md) — autenticação, autorização e segurança.
|
|
- [docs/DATABASE.md](docs/DATABASE.md) — estrutura e decisões de dados.
|
|
- [docs/DEVOPS.md](docs/DEVOPS.md) — execução local, deploy e operação.
|
|
- [docs/ROADMAP.md](docs/ROADMAP.md) — direção de produto e engenharia.
|
|
- [docs/TASKS.md](docs/TASKS.md) — tarefas e acompanhamento de execução.
|
|
|
|
### Documentação por componente
|
|
|
|
- [backend/BACKEND.md](backend/BACKEND.md)
|
|
- [frontend/FRONTEND.md](frontend/FRONTEND.md)
|
|
- [backoffice/BACKOFFICE.md](backoffice/BACKOFFICE.md)
|
|
- [seeder-api/SEEDER-API.md](seeder-api/SEEDER-API.md)
|
|
|
|
---
|
|
|
|
## 🚀 Quick start
|
|
|
|
### Pré-requisitos
|
|
|
|
- Go 1.24+
|
|
- Node.js 20+
|
|
- PostgreSQL 16+
|
|
|
|
### Subindo localmente
|
|
|
|
```bash
|
|
# 1) clone
|
|
git clone https://github.com/rede5/gohorsejobs.git
|
|
cd gohorsejobs
|
|
|
|
# 2) variáveis de ambiente (ajuste os valores)
|
|
cp backend/.env.example backend/.env
|
|
cp frontend/.env.example frontend/.env
|
|
|
|
# 3) backend
|
|
cd backend
|
|
go run ./cmd/api
|
|
|
|
# 4) frontend (novo terminal)
|
|
cd ../frontend
|
|
npm install
|
|
npm run dev
|
|
|
|
# 5) seeder (opcional)
|
|
cd ../seeder-api
|
|
npm install
|
|
npm run seed
|
|
```
|
|
|
|
### Script auxiliar
|
|
|
|
```bash
|
|
./start.sh
|
|
```
|
|
|
|
---
|
|
|
|
## 🧱 Estrutura resumida
|
|
|
|
```text
|
|
gohorsejobs/
|
|
├── backend/
|
|
├── frontend/
|
|
├── backoffice/
|
|
├── seeder-api/
|
|
├── docs/
|
|
├── k8s/
|
|
└── start.sh
|
|
```
|
|
|
|
---
|
|
|
|
## 🤝 Contribuição
|
|
|
|
1. Crie uma branch de feature/fix.
|
|
2. Faça commits pequenos e objetivos.
|
|
3. Atualize documentação relevante em `docs/` quando necessário.
|
|
4. Abra PR com contexto, impacto e evidências de teste.
|