4  Tarea: Creación de repositorio para el desarrollo de la webapp

Objetivo

Crear un repositorio en GitHub para el proyecto de la webapp utilizando una narrativa computacional.

Requisitos y consideraciones

• Estructura del repositorio:
  Se debe organizar el repositorio en carpetas con nombres que reflejen su contenido. Por ejemplo:
  • data/: para conjuntos de datos o archivos de entrada.
    
  • docs/: para documentación técnica y de usuario.
    
  • img/: para imágenes, gráficos y recursos visuales.
    
  • notebooks/: para notebooks de análisis, pruebas o desarrollo interactivo.
    
  • Otras carpetas pertinentes (por ejemplo, src/, scripts/, etc.) según las necesidades del proyecto.

Importante

Recuerda que la estructura de arriba es sugerida, ten una conversación seria con chatGPT sobre la estructura de tu proyecto.

• Archivo .gitignore:
  Es fundamental incluir un archivo .gitignore bien configurado para evitar subir archivos temporales, logs, dependencias locales u otros archivos que no se requieran en el repositorio.

• Documentación en el README.md:
  Actualizar el archivo README.md para incluir una breve descripción de cada carpeta y explicar su propósito. Ejemplo:

  • data/: Contendrá todos los archivos de datos necesarios para el funcionamiento o análisis del proyecto.
    
  • docs/: Albergará la documentación relacionada con la instalación, uso y desarrollo del proyecto.
    
  • img/: Incluirá imágenes, diagramas y otros recursos visuales.
    
  • notebooks/: Guardará notebooks de pruebas, análisis exploratorio y prototipado.

• Carpetas vacías en GitHub:
  Es importante recordar que GitHub no permite la creación de carpetas vacías.
  Consejo: Para evitar este inconveniente, agregar un archivo placeholder (por ejemplo, .gitkeep) dentro de cada carpeta que inicialmente esté vacía.

Pasos a seguir

1. Inicialización del repositorio:
   • Crear un nuevo repositorio en GitHub con el nombre correspondiente al proyecto de la webapp.
2. Configuración de la estructura:
   • Crear las carpetas necesarias (data/, docs/, img/, notebooks/, etc.).
     
   • Si alguna carpeta se crea vacía, incluir un archivo vacio .gitkeep dentro de ella para que se suba correctamente al repositorio.
3. Incorporación del archivo .gitignore:
   • Añadir un archivo .gitignore en la raíz del repositorio y configurarlo para ignorar archivos temporales, logs, dependencias locales y otros archivos innecesarios.
4. Documentación:
   • Modificar el archivo README.md para incluir una breve descripción de cada carpeta, explicando su función en el proyecto.
5. Commit inicial y verificación:
   • Realizar un commit inicial con la estructura completa y subirlo a GitHub.
     
   • Verificar en la interfaz de GitHub que la estructura se muestra correctamente.
   • Compartir en el classroom la liga de tu proyecto, que sea público.

Notas adicionales

• La organización clara y coherente del repositorio facilitará la colaboración y el mantenimiento del proyecto.