README Studio es una aplicación web open source diseñada para Herramienta open source para generar README profesionales de GitHub mediante bloques guiados y vista previa en tiempo real.
Este proyecto forma parte del ecosistema MiPrimerIssue, una iniciativa orientada a que desarrolladores junior hispanohablantes puedan contribuir a proyectos reales mediante tareas guiadas, progresivas y útiles para su aprendizaje.
README Studio permite:
- Crear README desde un formulario guiado
- Vista previa en tiempo real
- Plantillas por tipo de proyecto
- Copiar y exportar Markdown
- Aprender estructura de documentación profesional
Generar README profesionales para proyectos de GitHub con secciones guiadas, vista previa y exportación en Markdown.
Este proyecto utiliza:
- Next.js
- TypeScript
- Tailwind CSS
- Supabase
Clona el repositorio:
git clone https://github.com/MiPrimerIssue/readme-studio.git
cd readme-studioInstala dependencias:
npm installCopia el archivo de entorno:
cp .env.example .env.localEjecuta el proyecto en local:
npm run devAbre en tu navegador:
http://localhost:3000
docs/ → documentación general del proyecto
tasks/ → tareas organizadas por nivel
.github/ → plantillas de Pull Requests e Issues
src/ → código fuente de la aplicación
- Lee
CONTRIBUTING.md - Revisa la carpeta
tasks/ - Solicita una tarea desde MiPrimerIssue
- Espera a que se te asigne
- Trabaja en tu solución
- Abre una Pull Request
- Project Info Form
- README Preview Panel
- Empty Template State
- Template Selector
- Markdown Export
- Definición del proyecto y estructura base
- Primera versión funcional de la UI
- Componentes reutilizables principales
- Estados vacíos y feedback visual
- Filtros o navegación secundaria
- Página de detalle
- Mejoras de accesibilidad
- Tests básicos
Este repositorio no solo busca construir una herramienta útil, sino también servir como entorno real de aprendizaje para desarrolladores que quieren dar sus primeros pasos en open source.
Este proyecto se distribuye bajo licencia MIT.