Add README with Docker instructions

This commit is contained in:
2026-01-24 13:34:45 +01:00
parent 52b5b301ef
commit 5827382436

35
README.md Normal file
View File

@@ -0,0 +1,35 @@
# Ballet Production Suite ERP/CRM
Este proyecto es un ERP/CRM completo diseñado para la gestión de un atelier de ropa de ballet.
## 🚀 Inicio Rápido con Docker
La forma más sencilla de ejecutar la aplicación es utilizando Docker Compose. Esto levantará el Backend (FastAPI), el Frontend (NiceGUI) y una base de datos PostgreSQL.
```bash
docker-compose up --build
```
- **Frontend**: http://localhost:8080 (Interfaz en Español)
- **Backend API**: http://localhost:8000 (Lógica en Inglés)
- **Documentación API**: http://localhost:8000/docs
## 🛠️ Tecnologías Utilizadas
- **Backend**: FastAPI, SQLModel (ORM), JWT Authentication, PostgreSQL.
- **Frontend**: NiceGUI (Python-based UI framework), HTTTPX.
- **Infraestructura**: Docker, Docker Compose.
## 📁 Estructura del Proyecto
- `backend/`: Código de la API, modelos de base de datos y lógica de negocio.
- `frontend/`: Código de la interfaz de usuario y páginas.
- `docker-compose.yml`: Configuración de los servicios.
## 🔑 Autenticación
El sistema está preparado para autenticación JWT. Por defecto, puedes configurar las claves en el archivo `docker-compose.yml` o mediante un archivo `.env`.
---
Desarrollado para **DeBalletAtelier**.