-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Open
Labels
DocumentationImprovements or additions to documentationImprovements or additions to documentation
Description
Descripción del problema:
Actualmente, el archivo README.md principal del proyecto no incluye un paso a paso claro sobre cómo ejecutar el proyecto localmente.
Esto puede generar dificultades para los nuevos colaboradores o usuarios que no están familiarizados con la configuración inicial.
Propuesta de solución:
Agregar una sección en el README.md con las instrucciones básicas, por ejemplo:
- Clonar el repositorio.
- Instalar las dependencias con
npm installoyarn install. - Configurar las variables de entorno necesarias.
- Ejecutar el proyecto con
npm run devo el comando correspondiente. - Verificar que la aplicación funciona correctamente en el puerto indicado.
Beneficios:
- Facilita la incorporación de nuevos colaboradores.
- Reduce la cantidad de dudas recurrentes.
- Mejora la experiencia de quienes quieren probar el proyecto.
Metadata
Metadata
Assignees
Labels
DocumentationImprovements or additions to documentationImprovements or additions to documentation