Skip to content

ZergioPC/UMNG_Imaginatio

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

217 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🌌 Imaginatio Webapp 🎮

Proyecto final de Diseño II

Este proyecto busca la creación de una Plataforma Comunitaria mediante la cual se de gestión y promoción al Imaginatio, evento organizado por la carrera de Ingeniería Multimedia en la Universidad Militar Nueva Granada.

Es una red social donde los equipos del evento pueden realizar publicaciones de su progreso, a su vez que los espectadores pueden ver informacion acerca del evento y sus actividades.

Cuenta tambien con una mascota, minijuego que funciona a base de los me gusta dados por el visitante a cada publicacion.

Setup

1. Clonar el Repositorio

git clone https://github.com/ZergioPC/UMNG_Imaginatio.git
cd UMNG_Imaginatio

2. Opciones de Ejecución

Puedes ejecutar el proyecto de dos maneras:

A. Usando Docker (Recomendado)

Esta es la forma más sencilla de levantar todo el entorno.

Requisitos:

Ejecución:

  1. Asegúrate de que Docker esté en ejecución.

  2. En la raíz del proyecto, ejecuta:

    docker compose up --build -d

    Esto iniciará:

    • El backend en http://localhost:8000
    • El frontend en http://localhost:8080
  3. Para detener los servicios, ejecuta: docker compose down.

B. Setup Manual

Si prefieres configurar cada parte por separado:

Backend

El backend está programado en Python con FastAPI. Para configurarlo correctamente, es recomendable usar un entorno virtual.

Primero, ubícate en la carpeta del backend:

cd ./backend

Crea un entorno virtual (si no existe ya):

python -m venv env

Activa el entorno virtual. El comando varía según tu sistema operativo:

En Linux/macOS:

source env/bin/activate

En Windows:

.\env\Scripts\activate

Una vez activado, instala las dependencias correspondientes:

pip install -r requirements.txt

Finalmente, ejecuta esta línea de código para que el servidor esté disponible de forma local:

uvicorn main:app --host 0.0.0.0 --port 8000

Para desactivar el entorno virtual cuando termines, simplemente ejecuta deactivate.

Base de datos: La base de datos utilizada de momento es SQLite, manejada con SQLModel.

Frontend

El frontend está hecho en HTML, CSS y JS vanilla. Para visualizarlo, simplemente abre el archivo index.html en tu navegador. No es necesario levantar ningún servidor.

API Es el endpoint para comunicarse con el Backend. Puede ser modificado en el archivo frontend/js/config.js.

Creditos

  • Los iconos del frontend fueron obtenidos de SVGRepo.
  • Los assets de la mascota son de elaboracion propia

About

Repositorio para la creación de una red social enfocado a la promoción del evento IMAGINATIO de la Universidad Militar Nueva Granada

Topics

Resources

License

Stars

Watchers

Forks

Contributors