Skip to content

Latest commit

 

History

History
561 lines (416 loc) · 30.8 KB

File metadata and controls

561 lines (416 loc) · 30.8 KB

Studyield

Live Site License GitHub Stars Issues Pull Requests

Documentación | Inicio Rápido | Discusiones | Contribuir

🇬🇧 English | 🇯🇵 日本語 | 🇨🇳 中文 | 🇰🇷 한국어 | 🇪🇸 Español | 🇫🇷 Français | 🇩🇪 Deutsch | 🇧🇷 Português | 🇸🇦 العربية | 🇧🇩 বাংলা | 🇮🇳 हिन्दी | 🇷🇺 Русский


¿Qué es Studyield?

Studyield es una plataforma de aprendizaje de código abierto impulsada por IA que ayuda a los estudiantes a estudiar de manera más efectiva a través de contenido personalizado, tutoría inteligente y evaluaciones adaptativas. Construida para estudiantes, educadores y aprendices de por vida, Studyield combina tecnología de IA de vanguardia con ciencia del aprendizaje comprobada.

A diferencia de las plataformas de aprendizaje tradicionales que se centran únicamente en la entrega de contenido o las herramientas de tutoría de IA que carecen de funciones de estudio integrales, Studyield te brinda un ecosistema de aprendizaje completo con 6 características de IA potentes, un conjunto completo de herramientas de estudio y acceso multiplataforma.

Studyield Dashboard
Panel de aprendizaje impulsado por IA de Studyield

Cómo funciona

  1. Sube tus materiales -- Agrega materiales de estudio (PDF, documentos, exámenes pasados) a tu base de conocimientos
  2. La IA analiza y organiza -- Nuestra IA extrae conceptos clave, construye grafos de conocimiento y crea incrustaciones buscables
  3. Practica y aprende -- Genera exámenes de práctica, resuelve problemas con IA multiagente, haz cuestionarios con tarjetas didácticas
  4. Obtén retroalimentación -- Usa la evaluación de enseñanza inversa para probar tu comprensión e identificar lagunas de conocimiento
  5. Rastrea el progreso -- Monitorea tu velocidad de aprendizaje, niveles de dominio y patrones de estudio con análisis

Capacidades clave

  • 🎯 Clonar examen -- Sube exámenes pasados y genera nuevas preguntas de práctica con el mismo estilo, dificultad y formato
  • 🤖 Solucionador de problemas multiagente -- Los agentes de análisis, solución y verificación trabajan juntos para resolver problemas complejos con transmisión en tiempo real
  • 🕸️ Grafo de conocimiento -- Extrae automáticamente entidades y relaciones de materiales de estudio en visualizaciones interactivas
  • 🎙️ Evaluación de enseñanza inversa -- Los estudiantes explican conceptos (texto/voz), la IA evalúa la comprensión usando la Técnica Feynman
  • 🔬 Modo de investigación profunda -- RAG de materiales subidos + búsqueda web, produce informes estructurados con citas
  • 💻 Sandbox de código -- Ejecución segura de Python con soporte para NumPy, Pandas y bibliotecas científicas
  • 📚 Base de conocimientos -- Sube documentos (PDF, DOCX) para búsqueda semántica y RAG
  • 🃏 Tarjetas didácticas con SRS -- Sistema de repetición espaciada para memorización óptima
  • 📝 Cuestionarios generados por IA -- Generación automática de cuestionarios a partir de materiales de estudio
  • 💬 Chat RAG -- IA conversacional con citas de tus documentos
  • 🗺️ Rutas de aprendizaje -- Rutas de estudio óptimas generadas por IA
  • 📊 Análisis de progreso -- Rastrea tiempo de estudio, niveles de dominio y velocidad de aprendizaje
  • 🌍 12 idiomas -- Soporte completo de i18n (EN, JA, ZH, KO, ES, FR, DE, PT, AR, BN, HI, RU)
  • 📱 Web + Móvil -- Frontend React y aplicación móvil Flutter

Studyield Chat IA
Chat IA -- haz preguntas basadas en tus materiales de estudio subidos, con respuestas citadas de tus documentos

Qué problema resolvemos

El dilema del aprendizaje moderno

Los estudiantes de hoy se están ahogando en información pero muriendo de hambre por herramientas de aprendizaje efectivas. Los métodos de estudio tradicionales consumen mucho tiempo y son ineficientes, mientras que las soluciones de tutoría de IA existentes son demasiado caras, demasiado limitadas o requieren subir datos a plataformas propietarias.

Puntos débiles comunes que abordamos:

  • Materiales de práctica genéricos -- Los bancos de preguntas prefabricados no coinciden con tu estilo o dificultad de examen real
  • Herramientas de aprendizaje aisladas -- Tarjetas didácticas, cuestionarios y notas dispersos en múltiples aplicaciones
  • Sin verificación de comprensión profunda -- No se puede saber si realmente entiendes o simplemente memorizaste
  • Organización manual del conocimiento -- Horas desperdiciadas organizando notas y conectando conceptos
  • Tutoría de IA limitada -- La mayoría de los tutores de IA dan respuestas sin mostrar pasos de resolución de problemas o verificación
  • Preocupaciones de privacidad -- Subir materiales de estudio a plataformas de código cerrado
  • Costos altos -- Las herramientas de aprendizaje de IA premium cuestan $20-50/mes por estudiante

La solución de Studyield

Práctica al estilo del examen -- Clona tus exámenes reales para generar preguntas de práctica perfectamente adaptadas

Plataforma todo en uno -- Base de conocimientos, tarjetas didácticas, cuestionarios, chat, investigación y análisis en un solo lugar

Comprensión profunda -- La evaluación de enseñanza inversa y la resolución de problemas multiagente aseguran una verdadera comprensión

Grafos de conocimiento automáticos -- La IA extrae y conecta automáticamente conceptos de tus materiales

Características avanzadas de IA -- Resolución multiagente, investigación profunda, ejecución de código y transmisión en tiempo real

Auto-alojado y de código abierto -- Ejecuta en tu propia infraestructura, control total sobre tus datos

Gratis para empezar -- Código abierto con despliegue Docker, versión alojada opcional con precios justos

¿Por qué Studyield? (Comparación)

Característica Studyield Quizlet Anki ChatGPT Khan Academy
Clonar examen ✅ Generado por IA
Solucionador de problemas multiagente ✅ 3 agentes + transmisión ✅ Agente único
Grafos de conocimiento ✅ Generado automáticamente
Evaluación de enseñanza inversa ✅ Texto + voz ⚠️ Manual
Modo de investigación profunda ✅ RAG + web
Sandbox de código ✅ Ejecución segura
Tarjetas didácticas (SRS)
Chat RAG ✅ Con citas ✅ Sin docs N/A
Rutas de aprendizaje ✅ Generado por IA ✅ Pre-construido
Análisis de progreso ⚠️ Básico
Auto-alojado
Código abierto ✅ Apache 2.0 ✅ AGPL
Multiplataforma ✅ Web + Móvil
Curva de aprendizaje 🟢 Baja 🟢 Baja 🟡 Media 🟢 Baja 🟢 Baja

Studyield Solucionador multi-agente
Solucionador multi-agente -- los agentes de Análisis, Solución y Verificación colaboran en tiempo real para descomponer y verificar problemas complejos

¿Qué hace único a Studyield?

  1. Ecosistema de aprendizaje de IA completo -- 6 características avanzadas de IA (clonar examen, resolución multiagente, grafos de conocimiento, enseñanza inversa, investigación, sandbox de código) integradas con herramientas de estudio tradicionales (tarjetas didácticas, cuestionarios, notas)
  2. Arquitectura multiagente -- Primera plataforma de aprendizaje de código abierto con agentes de IA colaborativos para resolución y verificación de problemas
  3. Auto-alojado + Código abierto -- Control total sobre tus datos con despliegue Docker, a diferencia de plataformas propietarias
  4. Diseño centrado en exámenes -- Genera exámenes de práctica que coinciden con tu formato de prueba real, no bancos de preguntas genéricos
  5. Enfoque en comprensión profunda -- La evaluación de enseñanza inversa y la verificación de múltiples pasos aseguran una verdadera comprensión, no solo memorización

📊 Actividad del proyecto y estadísticas

Studyield es un proyecto mantenido activamente con una comunidad en crecimiento. Esto es lo que está sucediendo:

Actividad de GitHub

GitHub Stars Forks Contributors Last Commit

Open Issues Open PRs Closed Issues Closed PRs

Métricas de la comunidad

Métrica Estado Detalles
Total de contribuyentes Contributors Comunidad de desarrolladores en crecimiento
Total de commits Commits Desarrollo activo desde 2024
Commits mensuales Commit Activity Actualizaciones y mejoras regulares
Tiempo promedio de revisión de PR 24-48 horas Retroalimentación rápida de los mantenedores
Calidad del código Code Quality TypeScript + ESLint + Prettier
Cobertura de pruebas Coverage Pruebas unitarias + integración backend
Documentación Docs Documentación completa de API + guías para desarrolladores

Estadísticas de lenguaje y código

Top Language Language Count Repo Size License

Destacados de actividad reciente

  • Abril 2026 -- Primer lanzamiento de código abierto
  • 27 módulos backend -- auth, ai, content, exam-clone, problem-solver, teach-back, research, code-sandbox y más
  • Más de 120 endpoints API -- API REST + WebSocket integral
  • 12 idiomas -- Soporte completo de internacionalización
  • Soporte para 3 plataformas -- Web (React), Móvil (Flutter), API
  • Despliegue Docker -- Auto-alojamiento con un comando

Por qué importan estos números

Desarrollo activo -- Los commits y actualizaciones regulares significan que los errores se corrigen rápidamente y las características se agregan según la retroalimentación de la comunidad

Revisiones rápidas de PR -- El tiempo de revisión de 24-48 horas significa que tus contribuciones no permanecerán inactivas esperando la atención del mantenedor

Alta calidad del código -- TypeScript, ESLint, Prettier y pruebas exhaustivas aseguran una base de código estable y mantenible

Documentación integral -- Documentación completa de API, guías para desarrolladores y comentarios de código hacen que la incorporación sea fluida

Comunidad en crecimiento -- Más contribuyentes significa más características, mejores pruebas y perspectivas diversas sobre la dirección del producto

¡Únete a la actividad!

¿Quieres ver tus contribuciones aquí? ¡Consulta nuestra Guía rápida de contribución a continuación!

Inicio rápido

Docker (Recomendado)

Ejecuta estos comandos desde la raíz del proyecto:

git clone https://github.com/studyield/studyield.git
cd studyield
cp backend/.env.example backend/.env
# Edita backend/.env con tus credenciales de base de datos y clave API de OpenRouter
docker compose --env-file .env.docker up -d

¡Eso es todo! Accede a la aplicación en http://localhost:5189 y a la API en http://localhost:3010.

Configuración manual

Requisitos previos: Node.js 20+, PostgreSQL 15+, Redis 7+

# Clonar
git clone https://github.com/studyield/studyield.git
cd studyield

# Backend
cd backend
cp .env.example .env    # Edita .env con tu configuración
npm install
npm run migrate
npm run start:dev

# Frontend (en una nueva terminal)
cd frontend
cp .env.example .env
npm install
npm run dev

Visita http://localhost:5189 para acceder a la aplicación.

Inicio con un comando (Desarrollo)

./start.sh

Esto inicia PostgreSQL, Redis, Qdrant y ClickHouse a través de Docker, luego lanza los servidores de desarrollo backend y frontend.

Arquitectura

┌─────────────────────────────────────────────────────────────────┐
│                       Studyield Platform                        │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  ┌──────────────┐     ┌──────────────┐     ┌──────────────┐     │
│  │   React Web  │     │   Flutter    │     │  REST + WS   │     │
│  │  (Frontend)  │     │    Mobile    │     │     API      │     │
│  └──────────────┘     └──────────────┘     └──────────────┘     │
│                                                                 │
│  ┌───────────────────────────────────────────────────────────┐  │
│  │               NestJS Backend (27 Modules)                 │  │
│  ├───────────────────────────────────────────────────────────┤  │
│  │  Auth │ AI │ Exam Clone │ Problem Solver │ Chat           │  │
│  │  Teach-Back │ Research │ Knowledge Graph │ Quiz           │  │
│  │  Flashcards │ Learning Paths │ Analytics │ ...            │  │
│  └───────────────────────────────────────────────────────────┘  │
│                                                                 │
│  ┌───────────┐   ┌───────────┐   ┌───────────┐   ┌───────────┐  │
│  │PostgreSQL │   │   Redis   │   │  Qdrant   │   │ClickHouse │  │
│  │(Core Data)│   │(Cache+MQ) │   │ (Vectors) │   │(Analytics)│  │
│  └───────────┘   └───────────┘   └───────────┘   └───────────┘  │
│                                                                 │
│  ┌───────────────────────────────────────────────────────────┐  │
│  │  External Services: OpenRouter, OpenAI, Cloudflare R2,    │  │
│  │  AWS SES, Firebase, Stripe                                │  │
│  └───────────────────────────────────────────────────────────┘  │
└─────────────────────────────────────────────────────────────────┘

Frontend (/frontend) -- React 19, Vite, TypeScript, Tailwind CSS, Radix UI (shadcn), Zustand, React Query, i18next

Móvil (/mobile) -- Flutter 3.10+, Provider + BLoC, Dio, Go Router, Firebase, Easy Localization

Backend (/backend) -- NestJS 10, TypeScript, PostgreSQL (SQL raw), Redis, Qdrant, ClickHouse, BullMQ, Socket.io

Stack tecnológico

Capa Tecnología
Backend NestJS 10, TypeScript, PostgreSQL (SQL raw), Redis, Qdrant, ClickHouse, BullMQ, Socket.io
Frontend React 19, Vite, TypeScript, Tailwind CSS, Radix UI (shadcn), Zustand, React Query, i18next
Móvil Flutter 3.10+, Provider + BLoC, Dio, Go Router, Firebase, Easy Localization
IA OpenRouter (Claude, GPT, etc.), OpenAI Embeddings, LangChain
Infraestructura Docker Compose, Nginx, PM2, GitHub Actions CI/CD
Almacenamiento Cloudflare R2, AWS SES, Firebase Cloud Messaging
Pagos Stripe (suscripciones + webhooks)

i18n

Studyield admite 12 idiomas a través de i18next (frontend) y Easy Localization (móvil):

  • English, 日本語, 中文, 한국어, Español, Français, Deutsch, Português, العربية, বাংলা, हिन्दी, Русский

¿Quieres agregar un nuevo idioma? Consulta la guía de traducción.

🚀 ¿Por qué contribuir a Studyield?

Studyield es más que solo otro proyecto de código abierto -- es una oportunidad para construir el futuro de la educación impulsada por IA y hacer que el aprendizaje de calidad sea accesible para millones de estudiantes en todo el mundo.

Lo que obtendrás

📚 Aprende stack tecnológico moderno

  • NestJS + TypeScript -- Arquitectura backend de nivel empresarial con inyección de dependencias y diseño modular
  • React 19 + Vite -- Últimas características de React con compilaciones ultrarrápidas
  • Flutter -- Desarrollo móvil multiplataforma para iOS y Android
  • Integración AI/ML -- Trabaja con LLM, incrustaciones, bases de datos vectoriales y sistemas multiagente
  • Sistemas en tiempo real -- WebSockets, transmisión y arquitectura basada en eventos
  • DevOps -- Docker, CI/CD, auto-alojamiento e infraestructura como código

💼 Construye tu portafolio

  • Contribuye a una plataforma lista para producción utilizada por estudiantes en todo el mundo
  • Trabaja en características que aparecen en tu perfil de GitHub
  • Obtén reconocimiento en nuestro salón de la fama de contribuyentes
  • Desarrolla experiencia en educación impulsada por IA y EdTech -- habilidades altamente valoradas en 2026

🤝 Únete a una comunidad en crecimiento

  • Conéctate con desarrolladores de todo el mundo
  • Obtén revisiones de código de mantenedores experimentados
  • Aprende las mejores prácticas en arquitectura de software
  • Participa en discusiones técnicas y decisiones de diseño

🎯 Haz un impacto real

  • Tu código ayudará a los estudiantes a aprender de manera más efectiva y lograr sus objetivos académicos
  • Ve tus características siendo utilizadas en entornos de producción
  • Influye en la dirección del EdTech de código abierto

⚡ Incorporación rápida

  • Docker Compose te pone en marcha en menos de 5 minutos
  • Base de código bien documentada con arquitectura clara
  • Mantenedores amigables que responden a PR dentro de 24-48 horas
  • Etiquetas de "good first issue" para principiantes

🗺️ Hoja de ruta del proyecto

Para obtener información detallada sobre lo que se ha completado, lo que está en progreso y lo que planeamos a continuación, consulta nuestro Objetivos futuros y briefing para desarrolladores.

Este documento incluye:

  • ✅ Trabajo de preparación de código abierto completado
  • 🚧 Prioridades actuales (limpieza de código, configuración de Docker, documentación)
  • 🔮 Mejoras y características futuras

Cómo influir en la hoja de ruta

💡 ¿Tienes ideas? Abre una Discusión de GitHub o contribuye a hilos existentes

🗳️ Vota por características -- Marca con estrella los problemas que te importan para ayudarnos a priorizar

🛠️ ¿Quieres construir algo que no está en la lista? -- ¡Proponlo! Nos encantan las características impulsadas por la comunidad

🎯 Guía rápida de contribución

Comienza a contribuir en menos de 5 minutos:

Paso 1: Configura tu entorno

# Bifurca el repositorio en GitHub, luego clona tu bifurcación
git clone https://github.com/YOUR_USERNAME/studyield.git
cd studyield

# Comienza con Docker (forma más fácil)
cp backend/.env.example backend/.env
docker compose --env-file .env.docker up -d

# Accede a la aplicación
# Frontend: http://localhost:5189
# Backend API: http://localhost:3010

¡Eso es todo! Estás ejecutando Studyield localmente.

Paso 2: Encuentra algo en qué trabajar

Elige según tu nivel de experiencia:

🟢 Apto para principiantes

🟡 Intermedio

🔴 Avanzado

Paso 3: Haz tus cambios

# Crea una nueva rama
git checkout -b feature/your-feature-name

# Haz tus cambios
# - Código backend: /backend/src/modules
# - Código frontend: /frontend/src
# - Código móvil: /mobile/lib

# Prueba tus cambios
# Backend: cd backend && npm run test
# Frontend: cd frontend && npm run build

# Confirma con un mensaje claro
git commit -m "feat: add voice input support for teach-back"

Paso 4: Envía tu Pull Request

# Empuja a tu bifurcación
git push origin feature/your-feature-name

# Abre un PR en GitHub
# - Describe qué cambiaste y por qué
# - Enlaza a problemas relacionados
# - Agrega capturas de pantalla si es un cambio de UI

¿Qué sucede después?

  • ✅ Las pruebas automatizadas se ejecutan en tu PR
  • 👀 Un mantenedor revisa tu código (generalmente dentro de 24-48 horas)
  • 💬 Podemos sugerir cambios o mejoras
  • 🎉 Una vez aprobado, ¡tu código se fusiona!

Consejos de contribución

Comienza pequeño -- Tu primer PR no necesita ser una característica enorme

📖 Lee el código -- Explora módulos y componentes existentes como referencia

Haz preguntas -- Únete a nuestras Discusiones si estás atascado

🧪 Escribe pruebas -- Los PR con pruebas se fusionan más rápido

📝 Documenta tu código -- Agrega comentarios para lógica compleja

¿Necesitas ayuda?

Contribuir

¡Damos la bienvenida a las contribuciones! Consulta nuestra Guía de contribución para comenzar.

Formas de contribuir:

  • Informa errores o solicita características a través de GitHub Issues
  • Envía pull requests para correcciones de errores o nuevas características
  • Mejora la documentación
  • Agrega traducciones (soportamos 12 idiomas)

Contribuyentes

¡Gracias a todas las personas increíbles que han contribuido a Studyield! 🎉

¿Quieres ver tu cara aquí? ¡Consulta nuestra Guía de contribución y comienza a contribuir hoy!

💬 Únete a nuestra comunidad

¡Conéctate con desarrolladores, obtén ayuda y mantente actualizado sobre los últimos desarrollos de Studyield!

GitHub Discussions Twitter

Dónde encontrarnos

Plataforma Propósito Enlace
💡 Discusiones de GitHub Hacer preguntas, compartir ideas, solicitudes de características Iniciar discusión
💬 Discord Únete a nuestra comunidad, chat en tiempo real Unirse a Discord
🐦 Twitter/X Actualizaciones de productos, anuncios, consejos @infoinletcom
📧 Correo electrónico Contacto directo con mantenedores [email protected]
🌐 Sitio web Documentación, guías, blog studyield.com

Pautas de la comunidad

  • 🤝 Sé respetuoso -- Trata a todos con respeto y amabilidad
  • 💡 Comparte conocimiento -- Ayuda a otros a aprender y crecer
  • 🐛 Informa problemas -- ¿Encontraste un error? Háznoslo saber en GitHub Issues
  • 🎉 Celebra victorias -- Comparte tus logros de aprendizaje e historias de éxito
  • 🌍 Piensa globalmente -- Somos una comunidad mundial con más de 12 idiomas

Seguridad

Por favor, informa las vulnerabilidades de seguridad de manera responsable. Consulta SECURITY.md para nuestra política de divulgación.

Licencia

Este proyecto está licenciado bajo la Licencia Apache 2.0.

Copyright 2025 Studyield Contributors.

Reconocimientos

Construido con NestJS, React, Flutter, PostgreSQL, Redis, Qdrant, ClickHouse, OpenRouter y muchas otras tecnologías de código abierto increíbles.


Sitio web | Documentación | Discusiones | Twitter


Construido con ❤️ por la comunidad de Studyield

Si encuentras útil este proyecto, ¡considera darle una estrella! ⭐

Star on GitHub