Organización general del repositorio - Ines023/Vampiro-Chaminade GitHub Wiki

Organización del repositorio

A continuación explico los diferentes archivos y carpetas contenidos en el repositorio, su contenido y propósito.

Estructura del proyecto

📁 venv/
📁 certs/
    📄 BaltimoreCyberTrustRoot.crt.pem
📁 migrations/
    ...
📁 Vampiro/
    📄 __init__.py
    📁 __pycache__/
    📁 database/
    📁 models/
    📁 services/
    📁 static/
    📁 templates/
    📁 utils/
    📁 views/
📈  .env
⚙️ config.py
📄 .gitignore
📄 requirements.txt
📄 startup.txt
📃 README.md

Archivos/Directorios del propio repositorio

📁 venv/

Carpeta que contiene el entorno virtual de Python.

Se generará automáticamente al seguir las instrucciones de la página sobre el Entorno Virtual. Por esa razón su contenido es irrelevante. No se incluye en el repositorio de Github.

📁 certs/

Carpeta que contiene certificados.

📄 BaltimoreCyberTrustRoot.crt.pem

Certificado raíz de confianza.

📁 migrations/

Carpeta que contiene archivos relacionados con las migraciones de la base de datos. La migraciones suponen mover, actualizar... la base de datos, el esquema de datos. Con Alembic que en este caso lo integra en nuestra app Flask-Migrate, podemos alterar el esquema de datos de forma controlada. Con control de versiones y automatizaciones.

Vamos a ignorar el contenido de la carpeta ya que se genera automáticamente.

📁 Vampiro/

Carpeta principal del proyecto.

📄 init.py

Archivo de inicialización del módulo.

  • 📁 database/

Carpeta que contiene archivos relacionados con la base de datos.

  • 📁 models/

Carpeta que contiene los modelos de datos.

  • 📁 services/

Carpeta que contiene servicios y lógica de negocio.

  • 📁 static/

Carpeta que contiene archivos estáticos (CSS, JS, imágenes).

  • 📁 templates/

Carpeta que contiene las plantillas HTML.

  • 📁 utils/

Carpeta que contiene utilidades y funciones auxiliares.

  • 📁 views/

Carpeta que contiene las vistas y controladores.

📈 .env

Archivo que contiene variables de entorno sensibles. No debe ser incluido en el repositorio.

⚙️ config.py

Archivo de configuración de la aplicación. En él crearemos un objeto de configuración donde cargaremos todas las variables de entorno que luego accederá nuestra app.

📄 .gitignore

Archivo que especifica qué archivos y carpetas deben ser ignorados por Git. Los archivos aquí contenidos no están sincronizados con el repositorio remoto, en otras palabras, no están disponibles para ser descargados por nadie.

📄 requirements.txt

Archivo que lista las dependencias del proyecto.

📄 README.md

Archivo que contiene la documentación principal del proyecto.

📄 startup.txt

Archivo que contiene el comando para iniciar el servidor de la aplicación.