Complete documentation for future sessions
- CLAUDE.md for AI agents to understand the codebase - GITEA-GUIDE.md centralizes all Gitea operations (API, Registry, Auth) - DEVELOPMENT-WORKFLOW.md explains complete dev process - ROADMAP.md, NEXT-SESSION.md for planning - QUICK-REFERENCE.md, TROUBLESHOOTING.md for daily use - 40+ detailed docs in /docs folder - Backend as submodule from Gitea Everything documented for autonomous operation. Co-Authored-By: Claude Sonnet 4.5 (1M context) <noreply@anthropic.com>
This commit is contained in:
86
docs/README.md
Normal file
86
docs/README.md
Normal file
@@ -0,0 +1,86 @@
|
||||
# AiWorker - Documentación
|
||||
|
||||
Sistema de orquestación de agentes IA (Claude Code) para automatización del ciclo completo de desarrollo.
|
||||
|
||||
## Índice de Documentación
|
||||
|
||||
### 01. Arquitectura
|
||||
- [Overview General](./01-arquitectura/overview.md)
|
||||
- [Stack Tecnológico](./01-arquitectura/stack-tecnologico.md)
|
||||
- [Flujo de Datos](./01-arquitectura/flujo-de-datos.md)
|
||||
- [Modelo de Datos](./01-arquitectura/modelo-datos.md)
|
||||
|
||||
### 02. Backend
|
||||
- [Estructura del Proyecto](./02-backend/estructura.md)
|
||||
- [Database Schema (MySQL)](./02-backend/database-schema.md)
|
||||
- [MCP Server](./02-backend/mcp-server.md)
|
||||
- [Integración con Gitea](./02-backend/gitea-integration.md)
|
||||
- [Sistema de Colas](./02-backend/queue-system.md)
|
||||
- [API Endpoints](./02-backend/api-endpoints.md)
|
||||
|
||||
### 03. Frontend
|
||||
- [Estructura del Proyecto](./03-frontend/estructura.md)
|
||||
- [Componentes Principales](./03-frontend/componentes.md)
|
||||
- [Gestión de Estado](./03-frontend/estado.md)
|
||||
- [Kanban Board](./03-frontend/kanban.md)
|
||||
- [Consolas Web](./03-frontend/consolas-web.md)
|
||||
|
||||
### 04. Kubernetes
|
||||
- [Setup del Cluster](./04-kubernetes/cluster-setup.md)
|
||||
- [Estructura de Namespaces](./04-kubernetes/namespaces.md)
|
||||
- [Deployments](./04-kubernetes/deployments.md)
|
||||
- [Gitea en K8s](./04-kubernetes/gitea-deployment.md)
|
||||
- [Networking y Ingress](./04-kubernetes/networking.md)
|
||||
|
||||
### 05. Agentes Claude Code
|
||||
- [Pods de Agentes](./05-agents/claude-code-pods.md)
|
||||
- [Herramientas MCP](./05-agents/mcp-tools.md)
|
||||
- [Comunicación con Backend](./05-agents/comunicacion.md)
|
||||
- [Ciclo de Vida](./05-agents/ciclo-vida.md)
|
||||
|
||||
### 06. Deployment
|
||||
- [CI/CD Pipeline](./06-deployment/ci-cd.md)
|
||||
- [GitOps con ArgoCD](./06-deployment/gitops.md)
|
||||
- [Preview Environments](./06-deployment/preview-envs.md)
|
||||
- [Staging y Producción](./06-deployment/staging-production.md)
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Instalar dependencias
|
||||
cd backend && bun install
|
||||
cd ../frontend && bun install
|
||||
|
||||
# Iniciar servicios locales (Docker Compose)
|
||||
docker-compose up -d
|
||||
|
||||
# Iniciar backend
|
||||
cd backend && bun run dev
|
||||
|
||||
# Iniciar frontend
|
||||
cd frontend && bun run dev
|
||||
```
|
||||
|
||||
## Stack Tecnológico
|
||||
|
||||
- **Frontend**: React 19.2 + TailwindCSS + Vite
|
||||
- **Backend**: Bun 1.3.6 + Express + TypeScript
|
||||
- **Database**: MySQL 8.0
|
||||
- **Cache/Queue**: Redis
|
||||
- **Git Server**: Gitea (auto-alojado)
|
||||
- **Orchestration**: Kubernetes
|
||||
- **CI/CD**: ArgoCD + GitHub Actions
|
||||
- **Agents**: Claude Code (Anthropic)
|
||||
|
||||
## Versiones
|
||||
|
||||
- React: 19.2
|
||||
- Bun: 1.3.6
|
||||
- Node: 20+ (para compatibilidad)
|
||||
- MySQL: 8.0
|
||||
- Kubernetes: 1.28+
|
||||
- Gitea: latest
|
||||
|
||||
## Contribución
|
||||
|
||||
Esta es una documentación viva que se actualiza según evoluciona el proyecto.
|
||||
Reference in New Issue
Block a user