diff --git a/README.md b/README.md index 3c5ec03..007c1a5 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ - [Getting Started]() - [Project Structure]() - [License]() +- [Github Pages]() - [Codecov](README#codecov) ## 🔧 Features @@ -124,6 +125,11 @@ classconnect-backoffice/ MIT License. +## Github Pages + +You can access the published backoffice user guide at the following link: +https://is2-class-connect.github.io/classconnect-backoffice/ + ## Codecov [![codecov](https://codecov.io/gh/IS2-Class-Connect/classconnect-backoffice/graph/badge.svg?token=6QwXr8HFIm)](https://codecov.io/gh/IS2-Class-Connect/classconnect-backoffice) diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..e9c8d23 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,280 @@ + + + + + +Guía del Usuario – Backoffice + + + + +

🛠️ Guía del Usuario – Backoffice

+ +
+

📌 Índice

+
    +
  1. Introducción
    2. +
  2. Inicio de Sesión
    3. +
  3. Registro de Administradores
    4. +
  4. Gestión de Usuarios y Permisos
    5. +
  5. Configuración de Reglas y Normativas
    6. +
  6. Soporte
    7. +
+
+ +
+ +
+

📌 Introducción

+

El backoffice es una herramienta diseñada para que los administradores puedan gestionar usuarios, accesos, configuraciones y normativas dentro de la plataforma. Esta guía tiene como objetivo brindar una referencia clara sobre cómo utilizar las principales funcionalidades del sistema.

+
+ +
+ +
+

🔑 Inicio de Sesión

+ +

¿Cómo acceder?

+
    +
  1. Ingresar a la URL del backoffice: https://classconnect-backoffice.vercel.app/
    2. +
  2. Completar los campos de correo electrónico y contraseña.
    3. +
  3. Hacer clic en Iniciar Sesión.
    4. +
+ +

Mensajes posibles

+
    +
  • ✅ Inicio exitoso: El sistema redirigirá al panel principal.
    • +
  • ❌ Error en las credenciales: Se mostrará un mensaje indicando que los datos ingresados no son válidos.
    • +
+
+ +
+ +
+

📝 Registro de Administradores

+ +

¿Cómo registrar a un nuevo administrador?

+
    +
  1. Ingresar con una cuenta de administrador.
    2. +
  2. Hacer clic donde dice "Register an Admin here".
    3. +
  3. Completar el formulario con los datos requeridos.
    4. +
  4. Hacer clic en Register.
    5. +
+ +

Resultados esperados

+
    +
  • ✅ Registro exitoso: El nuevo administrador podrá acceder al sistema utilizando sus credenciales.
    • +
  • ⚠️ Datos faltantes o inválidos: Se indicarán los errores para su corrección.
    • +
  • ❌ Fallo del servicio: El sistema informará si no se puede procesar la solicitud.
    • +
+
+ +
+ +
+

👥 Gestión de Usuarios y Permisos

+ +

Visualización del listado de usuarios

+
    +
  • En la página de inicio, se mostrará un listado con nombre, rol, estado (activo/bloqueado) y fecha de registro de cada usuario.
    • +
+ +

Edición de roles y permisos

+
    +
  1. Para cada usuario, se visualizará la opción de modificar su rol según corresponda.
    2. +
  2. Se mostrará una opción para confirmar los cambios realizados.
    3. +
  3. El sistema confirmará que la actualización fue realizada con éxito.
    4. +
+ +

Bloqueo y desbloqueo de usuarios

+
    +
  1. Desde el listado, para cada usuario se podrá utilizar el botón correspondiente para Block o Unblock.
    2. +
  2. Se mostrará una opción para confirmar los cambios realizados.
    3. +
  3. El sistema confirmará que la actualización fue realizada con éxito.
    4. +
+ +

Registro de auditoría

+
    +
  • Toda modificación será registrada automáticamente, incluyendo:
    • +
      +
    • Usuario afectado
      • +
    • Acción realizada
      • +
    • Fecha y hora
      • +
    +
+
+ +
+ +
+

📋 Configuración de Reglas y Normativas

+ +

Creación y modificación de reglas

+
    +
  1. En la página de inicio, estará disponible un botón "Add rules" para acceder a configuración de las reglas.
    2. +
  2. Para crear una nueva regla, completar el formulario con todos los datos pedidos y hacer clic en "Add rule".
    3. +
  3. Para editar una existente, seleccionarla del listado, haciendo clic en "Edit".
    4. +
  4. Completar o modificar los campos requeridos: +
      +
    • Título
      • +
    • Descripción
      • +
    • Fecha de vigencia
      • +
    • Condiciones de aplicación
      • +
    +
    5. +
+ +

Validaciones

+
    +
  • El sistema validará la integridad de los datos. No será posible guardar reglas con información incompleta.
    • +
+ +

Publicación y notificaciones

+
    +
  • Una vez guardadas, las normativas se publicarán y se notificará a los usuarios relevantes mediante correo electrónico y/o notificaciones push.
    • +
+ +

Registro de cambios

+
    +
  • Todas las acciones realizadas quedarán registradas: +
      +
    • Usuario que efectuó el cambio
      • +
    • Tipo de modificación
      • +
    • Fecha y hora
      • +
    +
    • +
+
+ +
+ +
+

📞 Soporte

+

Para consultas técnicas o reportes de errores, contactarse con el equipo de soporte:
+📧 classconnect.team.uba@gmail.com

+
+ + +