Modular

Proyecto creado por:

• Luis M. Sempere Gómez (@sempereluismi)
• Manuel A. Chaves Herrera (@mmanuch)
• David Villar Durán (@davidvillard)
• Andrea Tena Fernández (@a22andreatf)

Index.

• Modular
  • Index.
  • Overview
  • Requirements
  • Installation
  • Run with docker in development enviroment
  • Deployment
  • Project Organization

Overview

Este repositorio contiene el código para crear un programa que permite la repartición de módulos. Hay que insertar un CSV para la creación en la base de datos de los profesores y los módulos; al finalizar la asignación de módulos se obtiene otro CSV.

Requirements

Este proyecto ha sido desarrollado usando Vite. Así que es necesario instalar npm y node 20.

Installation

Todas las demás librerías que son requeridas puden instalarse usando el comando:

    npm install

Run with docker in development enviroment

Para poder lanzar el proyecto es necesario instalar los contenedores de docker. Nos situamos en la carpeta principal (modular) y creamos el docker.

Puedes hacerlo con:

 docker compose up -d .

Una vez creado enciendelo y listo.

Para poder acceder a la parte del frontend (cliente) nos servimos del puerto 80:

Deployment

Limpiar el cache de docker para no llenar la memoria de la máquina

docker system prune

Lanzar el docker

docker compose up -d --force-recreate --build

Project Organization

├── BBDD
│   ├── MER
│   ├── CSV
|   └── archivos
├── client
│   ├── public
│   ├── archivos
│   └── src
│       ├── assets
│       ├── components
│       ├── context
│       ├── helpers
│       ├── hooks
│       ├── layouts
│       ├── routes
│       ├── views
│       └── archivos
├── server
│   ├── app
│   |   ├── app
│   |   ├── docs
│   |   ├── logs
│   |   ├── public
│   |   ├── src
│   |   ├── test
│   |   ├── var
│   |   ├── vendor
│   │   └── archivos
│   ├── config
│   |   ├── sites-available
│   │   └── php.ini
│   └── Dockerfile
├── .gitignore
├── README.md
└── docker-compose.yml

• BBDD: Archivos necesarios para la utlización de la base de datos
• client: La parte frontend del proyecto
• server: La parte backend del proyecto
• archivos: Hace referencia a diferentes archivos que pueden estar dentro de la carpeta

Cabe recalcar que este es solo es el esqueleto de la primera capa, dentro de las subcarpetas hay más contenido impotante