Skip to content

README.md

Latest commit

 

History

History
189 lines (133 loc) · 5.35 KB

README.md

File metadata and controls

189 lines (133 loc) · 5.35 KB
Raw

⛰️ Levelest ⛰️

👥 Integrantes del equipo

  • Víctor Hugo Oliveira Petroceli
  • Samuel Melián Benito
  • Jaime Ochoa de Alda Cerdán
  • Naroa Martín Simón
  • Nerea Morocho Soria
  • David Martín Sanz

📱 Nombre de la aplicación

Levelest

🧠 Descripción general

Levelest es una aplicación educativa diseñada para ayudar a los estudiantes a preparar la EVAU (PAU) de forma dinámica, motivadora y competitiva. Permite realizar tests por asignatura, obtener estadísticas visuales, competir en un ranking global y gestionar completamente la cuenta de usuario.

La aplicación cuenta con un backend y base de datos dockerizados, conectados mediante una API, y se ejecuta de forma segura usando HTTPS. 🎓📈

✅ Funcionalidades implementadas

  • 🔐 Registro de usuario
  • 🔑 Inicio y cierre de sesión
  • 🌗 Modo claro / modo oscuro
  • 📝 Tests aleatorios por asignatura
  • 🏆 Ranking global según puntos obtenidos
    • Puntuación = nota del test × 10
  • 📊 Estadísticas con gráficos de aciertos y fallos
  • 🗑️ Eliminación de cuenta
  • 🔄 Persistencia de datos mediante API
  • 🐳 Backend, frontend y base de datos mediante Docker

🛠️ Tecnologías utilizadas

  • Frontend: React ⚛️
  • Backend: Node.js + Express 🚀
  • Lenguaje: JavaScript / TypeScript
  • Base de datos: Gestionada mediante API
  • Contenedores: Docker & Docker Compose 🐳
  • Diseño: Figma / Miró 🎨

🚀 Ejecución de la aplicación con Docker (RECOMENDADO)

Important

La aplicación DEBE ejecutarse usando HTTPS y Docker Desktop.

🧰 1. Requisitos previos

Antes de comenzar, asegúrate de tener instalado:

🐳 2. Iniciar Docker Desktop

  1. Abre Docker Desktop.
  2. Espera a que Docker esté completamente iniciado.
  3. Abre la terminal integrada de Docker Desktop (o tu terminal de preferencia).

📥 3. Descargar la última versión desde Docker Hub

  1. Accede al repositorio de Docker Hub: 👉 Repositorio granlobo2004/levelestapp-compose

  2. Copia el tag más reciente (última versión disponible).

  3. En la terminal ejecuta el tag copiado, por ejemplo:

    docker compose -f oci://granlobo2004/levelestapp-compose:1.0.0 up

Docker levantará automáticamente:

  • Frontend
  • Backend
  • API
  • Base de datos

🌐 4. Acceder a la aplicación

Abre tu navegador y entra en:

👉 https://localhost:3443/

Warning

Es obligatorio usar HTTPS. Si el navegador muestra una advertencia de seguridad (debido al certificado autofirmado local), acepta el riesgo y continúa.

🔧 5. Solución de problemas (Docker)

Si la web NO se monta automáticamente

  1. Abre Docker Desktop.
  2. Ve a la sección Containers.
  3. Busca el contenedor llamado web-1 (o levelest-web).
  4. Pulsa el botón Start ▶️ manualmente.

♻️ 6. Montar una nueva versión (IMPORTANTE)

Si ya habías montado una versión anterior y quieres usar una nueva:

  1. Detén los contenedores activos.

  2. Elimina los contenedores antiguos y las imágenes antiguas de Levelest.

  3. Ejecuta los siguientes comandos de limpieza:

    docker container prune
docker image prune

  4. Vuelve a descargar la nueva versión desde Docker Hub (es decir, copia el nuevo enlace en tags).

  5. Repite los pasos de ejecución.

Note

No borrar versiones antiguas puede provocar errores de montaje.

🧪 Ejecución en modo desarrollo (SIN Docker)

📦 1. Instalar dependencias

Desde la carpeta raíz del proyecto:

npm install

🔄 2. Iniciar la aplicación

npm run watch

🌍 3. Acceso local

La aplicación estará disponible en: http://localhost:3000

🛠️ 4. Comprobar Node.js

Si tienes problemas, verifica tus versiones:

node -v
npm -v

⚙️ Solución de problemas generales

  • Puertos ocupados: Cambia el puerto si el 3000 o 3443 están en uso.
  • Dependencias: Si falla, borra la carpeta node_modules y ejecuta npm install de nuevo.
  • Directorios: Asegúrate de ejecutar los comandos en el directorio raíz correcto del proyecto.

Hecho con JavaScript y Node.js

Proyecto desarrollado con dedicación, aprendizaje y trabajo en equipo, combinando educación y tecnología para mejorar la preparación de la EVAU.

Instrucciones para Ejecutar la Aplicación

Para ejecutar la aplicación, puedes usar el siguiente comando con Docker Compose. Asegúrate de tener Docker y Docker Compose instalados en tu máquina antes de continuar.

Requisitos

  • Docker instalado en tu máquina.
  • Docker Compose instalado (si no lo tienes, puedes instalarlo siguiendo la documentación oficial).

Pasos para ejecutar la aplicación

  1. Abre una terminal en la carpeta de tu proyecto.

  2. Ejecuta el siguiente comando para lanzar los servicios definidos en el archivo docker-compose.yml:

    docker compose -f oci://granlobo2004/levelestapp-compose:1.0.0 up