Developer Guide
This guide is intended for software engineers contributing to AuditorIA.
Local Development Setup
Prerequisites: Docker Desktop, Node.js 18+, Python 3.10+.
1. Clone the Repository
git clone https://github.com/your-org/AuditorIA.git
cd AuditorIA2. Run with Docker Compose
The easiest way to start the entire stack (Backend, Frontend, Database, MinIO, Keycloak) is:
docker-compose up --build3. Service Endpoints
| Service | URL | Credentials |
|---|---|---|
| Frontend | http://localhost:3000 | N/A |
| Backend API | http://localhost:8000/docs | N/A |
| MinIO Console | http://localhost:9001 | minioadmin / minioadmin |
| Keycloak | http://localhost:8008 | admin / admin |
Database Schema
AuditorIA uses PostgreSQL. Here is the high-level schema:
Authentication Flow (Keycloak)
- Frontend redirects user to Keycloak Login Page.
- User authenticates.
- Keycloak redirects back with
Authorization Code. - Frontend exchanges code for
Access Token+Refresh Token. - Frontend sends
Access Tokenin Authorization header to Backend. - Backend validates token signature (JWKS).