docs: update README with bilingual documentation
- Add English and Spanish sections - Improve project description and features - Add professional formatting
This commit is contained in:
Renato97
179
README.md
179
README.md
@@ -1,113 +1,112 @@
|
|||||||
# Plataforma de Aprendizaje de Economía
|
# 📚 Econ - Interactive Economics Learning Platform
|
||||||
|
|
||||||
## 📚 Descripción
|
## 📝 Description / Descripción
|
||||||
Plataforma web interactiva para enseñar economía a través de 4 módulos basados en material académico PDF.
|
|
||||||
|
|
||||||
## 🎯 Objetivo
|
**English:**
|
||||||
Crear una experiencia de aprendizaje gamificada con ejercicios interactivos, visualizaciones dinámicas y seguimiento de progreso.
|
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
|
## 🚀 Features / Características
|
||||||
- **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
|
|
||||||
|
|
||||||
### Módulo 2: Oferta, Demanda y Equilibrio
|
**English:**
|
||||||
- **Temas**: Curvas de oferta/demanda, equilibrio de mercado, controles de precios
|
- Interactive exercises with instant feedback
|
||||||
- **Ejercicios**: Constructor de curvas interactivo, Simulador de precios máximos/mínimos
|
- 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
|
**Español:**
|
||||||
- **Temas**: Utilidad marginal, elasticidades, clasificación de bienes
|
- Ejercicios interactivos con retroalimentación instantánea
|
||||||
- **Ejercicios**: Calculadora de elasticidad, Ejercicios tipo examen, Clasificador de bienes
|
- 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
|
## 🛠️ Tech Stack / Stack Tecnológico
|
||||||
- **Temas**: Costos, producción, competencia perfecta, maximización de beneficios
|
|
||||||
- **Ejercicios**: Simulador de decisión de producción, Calculadora de costos
|
|
||||||
|
|
||||||
## 🏗️ Arquitectura Técnica
|
### Backend
|
||||||
|
- **Language:** Go 1.21+
|
||||||
|
- **Framework:** Standard library + gorilla/mux
|
||||||
|
- **Database:** PostgreSQL
|
||||||
|
- **Authentication:** JWT
|
||||||
|
- **API:** RESTful
|
||||||
|
|
||||||
### Stack Tecnológico
|
### Frontend
|
||||||
- **Frontend**: React 18 + TypeScript + Tailwind CSS
|
- **Framework:** React 18 + TypeScript
|
||||||
- **Visualización**: D3.js + Recharts
|
- **Build Tool:** Vite
|
||||||
- **Estado**: Zustand
|
- **Styling:** Tailwind CSS
|
||||||
- **Routing**: React Router v6
|
- **State Management:** Zustand
|
||||||
- **Build**: Vite
|
- **Charts:** Custom D3/Recharts
|
||||||
- **Container**: Docker + Docker Compose
|
|
||||||
|
|
||||||
### Estructura de Carpetas
|
### Infrastructure
|
||||||
```
|
- **Containerization:** Docker + Docker Compose
|
||||||
econ-learning/
|
- **Reverse Proxy:** Nginx
|
||||||
├── src/
|
- **Deployment:** Self-hosted
|
||||||
│ ├── 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
|
|
||||||
```
|
|
||||||
|
|
||||||
## 🚀 Instrucciones de Despliegue
|
## 📚 Content Modules / Módulos de Contenido
|
||||||
|
|
||||||
### Desarrollo Local
|
1. **Module 1 / Módulo 1:** Introduction to Economics / Introducción a la Economía
|
||||||
```bash
|
- Economic agents / Agentes económicos
|
||||||
# Instalar dependencias
|
- Production factors / Factores de producción
|
||||||
npm install
|
- Opportunity cost / Costo de oportunidad
|
||||||
|
- PPF / FPP
|
||||||
|
|
||||||
# Iniciar servidor de desarrollo
|
2. **Module 2 / Módulo 2:** Supply and Demand / Oferta y Demanda
|
||||||
npm run dev
|
- 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
|
3. **Module 3 / Módulo 3:** Consumer Theory / Teoría del Consumidor
|
||||||
```bash
|
- Utility maximization / Maximización de utilidad
|
||||||
# Construir imagen
|
- Indifference curves / Curvas de indiferencia
|
||||||
docker-compose up -d
|
- Budget constraints / Restricciones presupuestarias
|
||||||
|
|
||||||
# Ver logs
|
4. **Module 4 / Módulo 4:** Producer Theory / Teoría del Productor
|
||||||
docker-compose logs -f
|
- 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)
|
**English:**
|
||||||
- [ ] Setup del proyecto con Vite + React + TS
|
1. Clone repository: `git clone <repo-url>`
|
||||||
- [ ] Configuración de Docker
|
2. Start with Docker Compose: `docker-compose up -d`
|
||||||
- [ ] Componentes base UI
|
3. Access frontend at `http://localhost`
|
||||||
- [ ] Estructura de routing
|
4. Backend API at `http://localhost:8080`
|
||||||
|
|
||||||
### Fase 2: Módulo 1 (Semana 3)
|
**Español:**
|
||||||
- [ ] Contenido teórico del Módulo 1
|
1. Clona repositorio: `git clone <repo-url>`
|
||||||
- [ ] Simulador de disyuntivas
|
2. Inicia con Docker Compose: `docker-compose up -d`
|
||||||
- [ ] Quiz de clasificación de bienes
|
3. Accede al frontend en `http://localhost`
|
||||||
- [ ] Juego del flujo circular
|
4. API backend en `http://localhost:8080`
|
||||||
|
|
||||||
### Fase 3: Módulo 2 (Semana 4)
|
## 🎯 Gamification / Gamificación
|
||||||
- [ ] Constructor de curvas interactivo
|
|
||||||
- [ ] Simulador de precios
|
|
||||||
- [ ] Ejercicios de equilibrio
|
|
||||||
|
|
||||||
### Fase 4: Módulos 3-4 (Semana 5-6)
|
- **Badges / Insignias:** Complete modules to earn badges
|
||||||
- [ ] Calculadora de elasticidad
|
- **Points / Puntos:** Score based on exercise accuracy
|
||||||
- [ ] Simulador de costos
|
- **Progress / Progreso:** Visual progress bars for each module
|
||||||
- [ ] Sistema de puntuación
|
- **Streaks / Rachas:** Consecutive day learning bonuses
|
||||||
|
|
||||||
### Fase 5: Pulido (Semana 7)
|
## 👨💻 Author / Autor
|
||||||
- [ ] Tests
|
|
||||||
- [ ] Optimización de rendimiento
|
|
||||||
- [ ] Documentación final
|
|
||||||
|
|
||||||
## 🔧 Requisitos del Sistema
|
**Renato CBC**
|
||||||
- Node.js 18+
|
- GitHub: [renato97](https://gitea.cbcren.online/renato97)
|
||||||
- Docker (opcional)
|
|
||||||
- Navegador moderno con soporte ES6+
|
|
||||||
|
|
||||||
## 📄 Licencia
|
## 📄 License / Licencia
|
||||||
Proyecto educativo personal.
|
|
||||||
|
Private project / Proyecto privado
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Tags / Etiquetas:** `go` `react` `typescript` `economics` `education` `gamification` `docker` `e-learning`
|
||||||
|
|||||||
Reference in New Issue
Block a user