docs: update README with bilingual documentation

- Add English and Spanish sections - Improve project description and features - Add professional formatting
2026-03-31 01:32:53 -03:00
parent ce9f0d5180
commit 08f1d61e25
1 changed files with 89 additions and 90 deletions
--- a/README.md
+++ b/README.md
@@ -1,113 +1,112 @@
-# Plataforma de Aprendizaje de Economía
+# 📚 Econ - Interactive Economics Learning Platform

-## 📚 Descripción
-Plataforma web interactiva para enseñar economía a través de 4 módulos basados en material académico PDF.
+## 📝 Description / Descripción

-## 🎯 Objetivo
-Crear una experiencia de aprendizaje gamificada con ejercicios interactivos, visualizaciones dinámicas y seguimiento de progreso.
+**English:**
+An interactive web platform for learning economics through exercises, simulations, and visualizations. Built with Go backend and React frontend, featuring gamification elements like badges, progress tracking, and achievement systems.

-## 📖 Módulos Educativos
+**Español:**
+Una plataforma web interactiva para aprender economía mediante ejercicios, simulaciones y visualizaciones. Construida con backend en Go y frontend en React, con elementos de gamificación como insignias, seguimiento de progreso y sistemas de logros.

-### Módulo 1: Fundamentos de Economía
- **Temas**: Definición de economía, agentes económicos, factores de producción, flujo circular
- **Ejercicios**: Simulador de disyuntivas, Quiz de clasificación de bienes, Juego del flujo circular
+## 🚀 Features / Características

-### Módulo 2: Oferta, Demanda y Equilibrio
- **Temas**: Curvas de oferta/demanda, equilibrio de mercado, controles de precios
- **Ejercicios**: Constructor de curvas interactivo, Simulador de precios máximos/mínimos
+**English:**
+- Interactive exercises with instant feedback
+- Supply and demand curve simulations
+- Production possibility frontier (PPF) visualizations
+- Elasticity calculators and exercises
+- Cost curves and profit maximization
+- Progress tracking with badges and scores
+- Audio classes and PDF resources
+- User authentication and data persistence
+- Responsive design for all devices

-### Módulo 3: Utilidad y Elasticidad
- **Temas**: Utilidad marginal, elasticidades, clasificación de bienes
- **Ejercicios**: Calculadora de elasticidad, Ejercicios tipo examen, Clasificador de bienes
+**Español:**
+- Ejercicios interactivos con retroalimentación instantánea
+- Simulaciones de curvas de oferta y demanda
+- Visualizaciones de frontera de posibilidades de producción (FPP)
+- Calculadoras y ejercicios de elasticidad
+- Curvas de costos y maximización de beneficios
+- Seguimiento de progreso con insignias y puntajes
+- Clases en audio y recursos PDF
+- Autenticación de usuarios y persistencia de datos
+- Diseño responsive para todos los dispositivos

-### Módulo 4: Teoría del Productor
- **Temas**: Costos, producción, competencia perfecta, maximización de beneficios
- **Ejercicios**: Simulador de decisión de producción, Calculadora de costos
+## 🛠️ Tech Stack / Stack Tecnológico

-## 🏗️ Arquitectura Técnica
+### Backend
+- **Language:** Go 1.21+
+- **Framework:** Standard library + gorilla/mux
+- **Database:** PostgreSQL
+- **Authentication:** JWT
+- **API:** RESTful

-### Stack Tecnológico
- **Frontend**: React 18 + TypeScript + Tailwind CSS
- **Visualización**: D3.js + Recharts
- **Estado**: Zustand
- **Routing**: React Router v6
- **Build**: Vite
- **Container**: Docker + Docker Compose
+### Frontend
+- **Framework:** React 18 + TypeScript
+- **Build Tool:** Vite
+- **Styling:** Tailwind CSS
+- **State Management:** Zustand
+- **Charts:** Custom D3/Recharts

-### Estructura de Carpetas
-```
-econ-learning/
-├── src/
-│   ├── components/          # Componentes reutilizables
-│   │   ├── charts/         # Gráficos interactivos
-│   │   ├── exercises/      # Ejercicios específicos
-│   │   └── ui/             # Componentes UI base
-│   ├── modules/            # Módulos educativos
-│   │   ├── clase1/
-│   │   ├── clase2/
-│   │   ├── clase3/
-│   │   └── clase4/
-│   ├── hooks/              # Custom hooks
-│   ├── stores/             # Estado global
-│   └── utils/              # Utilidades
-├── public/                 # Assets estáticos
-├── docker/                 # Configuración Docker
-└── docs/                   # Documentación técnica
-```
+### Infrastructure
+- **Containerization:** Docker + Docker Compose
+- **Reverse Proxy:** Nginx
+- **Deployment:** Self-hosted

-## 🚀 Instrucciones de Despliegue
+## 📚 Content Modules / Módulos de Contenido

-### Desarrollo Local
-```bash
-# Instalar dependencias
-npm install
+1. **Module 1 / Módulo 1:** Introduction to Economics / Introducción a la Economía
+   - Economic agents / Agentes económicos
+   - Production factors / Factores de producción
+   - Opportunity cost / Costo de oportunidad
+   - PPF / FPP

-# Iniciar servidor de desarrollo
-npm run dev
-```
+2. **Module 2 / Módulo 2:** Supply and Demand / Oferta y Demanda
+   - Law of demand / Ley de la demanda
+   - Law of supply / Ley de la oferta
+   - Market equilibrium / Equilibrio de mercado
+   - Elasticity / Elasticidad

-### Producción con Docker
-```bash
-# Construir imagen
-docker-compose up -d
+3. **Module 3 / Módulo 3:** Consumer Theory / Teoría del Consumidor
+   - Utility maximization / Maximización de utilidad
+   - Indifference curves / Curvas de indiferencia
+   - Budget constraints / Restricciones presupuestarias

-# Ver logs
-docker-compose logs -f
-```
+4. **Module 4 / Módulo 4:** Producer Theory / Teoría del Productor
+   - Production functions / Funciones de producción
+   - Cost curves / Curvas de costos
+   - Profit maximization / Maximización de beneficios

-## 📝 Roadmap
+## 🔧 Setup / Configuración

-### Fase 1: Fundamentos (Semana 1-2)
- [ ] Setup del proyecto con Vite + React + TS
- [ ] Configuración de Docker
- [ ] Componentes base UI
- [ ] Estructura de routing
+**English:**
+1. Clone repository: `git clone <repo-url>`
+2. Start with Docker Compose: `docker-compose up -d`
+3. Access frontend at `http://localhost`
+4. Backend API at `http://localhost:8080`

-### Fase 2: Módulo 1 (Semana 3)
- [ ] Contenido teórico del Módulo 1
- [ ] Simulador de disyuntivas
- [ ] Quiz de clasificación de bienes
- [ ] Juego del flujo circular
+**Español:**
+1. Clona repositorio: `git clone <repo-url>`
+2. Inicia con Docker Compose: `docker-compose up -d`
+3. Accede al frontend en `http://localhost`
+4. API backend en `http://localhost:8080`

-### Fase 3: Módulo 2 (Semana 4)
- [ ] Constructor de curvas interactivo
- [ ] Simulador de precios
- [ ] Ejercicios de equilibrio
+## 🎯 Gamification / Gamificación

-### Fase 4: Módulos 3-4 (Semana 5-6)
- [ ] Calculadora de elasticidad
- [ ] Simulador de costos
- [ ] Sistema de puntuación
+- **Badges / Insignias:** Complete modules to earn badges
+- **Points / Puntos:** Score based on exercise accuracy
+- **Progress / Progreso:** Visual progress bars for each module
+- **Streaks / Rachas:** Consecutive day learning bonuses

-### Fase 5: Pulido (Semana 7)
- [ ] Tests
- [ ] Optimización de rendimiento
- [ ] Documentación final
+## 👨‍💻 Author / Autor

-## 🔧 Requisitos del Sistema
- Node.js 18+
- Docker (opcional)
- Navegador moderno con soporte ES6+
+**Renato CBC**
+- GitHub: [renato97](https://gitea.cbcren.online/renato97)

-## 📄 Licencia
-Proyecto educativo personal.
+## 📄 License / Licencia
+
+Private project / Proyecto privado
+
+---
+
+**Tags / Etiquetas:** `go` `react` `typescript` `economics` `education` `gamification` `docker` `e-learning`