gohorsejobs/README.md
Tiago Yamamoto 6ec54460f8 docs: unify documentation structure
- Create docs/AGENTS.md for AI assistants context
- Create docs/WORKFLOWS.md consolidating deployment workflows
- Remove redundant docs/root/ folder
- Remove .agent/ folder (consolidated into docs/)
- Update dates in all documentation files
- Simplify README.md documentation section
2026-02-16 05:57:02 -06:00

2.2 KiB

🐴 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.

📚 Documentação

Documento Descrição
docs/AGENTS.md Contexto para assistentes de IA (Claude, Cursor, etc.)
docs/API.md Endpoints, contratos e exemplos
docs/API_SECURITY.md Autenticação, autorização e segurança
docs/DATABASE.md Estrutura e decisões de dados
docs/DEVOPS.md Execução local, deploy e operação
docs/WORKFLOWS.md Fluxos de deploy e operações
docs/ROADMAP.md Direção de produto e engenharia
docs/TASKS.md Tarefas e acompanhamento

Por componente


🚀 Quick start

Pré-requisitos

  • Go 1.24+
  • Node.js 20+
  • PostgreSQL 16+

Subindo localmente

# 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

./start.sh

🧱 Estrutura resumida

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.