Skip to content

rcsalinas/BackEnd-API

Repository files navigation

TPO - Aplicaciones Interactivas - Teachers Market

Tabla de Contenidos

  1. Introduccion
  2. Requerimientos
  3. Instalacion
  4. Funcionalidades
  5. Documentacion
  6. Documentacion de Postman
  7. Integrantes

Introduccion

Este proyecto es una página web llamada "Teachers Market", que se basa en conectar estudiantes y profesores particulares para la contratación de clases de diferentes materias. En la misma, también existe un sistema de calificación, puntuación y comentarios entre profesores y estudiantes. Los estudiantes podrán registrarse, buscar materias individuales, grupales, calificar una materia y/o a un profesor. Mientras que, por otro lado, los profesores tendrán la posibilidad de registrarse, crear nuevos cursos, aceptar estudiantes y comentarios recibidos sobre sus cursos dictados.

Requerimientos

Los requerimientos para poder instalar y utilizar la aplicacion web son:

Lenguajes y librerías utilizadas en el frontend: HTML/CSS, React, JavaScript y NodeJS.

Lenguajes y librerías utilizadas en el backend: JavaScript , NodeJS y Mongoose.

Base de datos: NoSQL (MongoDB).

Instalacion

Instalación para el BackEnd

Una vez ubicado sobre el root de la carpeta, ejecutar los siguientes comandos:

$ npm install -g nodemon
$ nodemon app.js

Si la secuencia se ejecuta correctamente, debe aparecer esto en la terminal:

Inicio BackEnd

Instalación para el FrontEnd

Una vez ubicado sobre el root de la carpeta, ejecutar los siguientes comandos:

$ npm install
$ npm start

Si la secuencia se ejecuta correctamente, se debe poder visualizar la página web desde el navegador:

Pagina Principal

Funcionalidades

En la página principal se pueden observar las materias que estan publicadas junto con su respectivo profesor, la calificación y el precio del curso.

También se puede realizar un filtrado por Materia, por tipo de clase (Individual o Grupal), por Frecuencia o por Calificación del curso.

Por otro lado, existe un link que dirige a la página de Cómo Funciona que es la sección donde se brinda información a los usuarios, acerca de las diferentes funcionalidades que tiene la página web.

Existe también el botón LOGIN que dirige a la página donde los usuarios pueden iniciar sesión o registrarse.

Descripcion Principal

La sección Cómo Funciona muestra diferente información de acuerdo a si el usuario está o no logueado, y, a su vez, depende de qué tipo de usuario sea (Profesor o Estudiante).

Como Funciona

La sección de LOGIN muestra la pantalla de inicio de sesión o registro.

Login

Si seleccionamos la opción de registrarnos, la página nos solicitará los datos de registro y que indiquemos si lo estamos haciendo en modalidad Estudiante o Profesor. Depende del tipo de registro, solicitará una información u otra.

Registro

Una vez realizado el registro, podemos ir a la sección Perfil y visualizar los datos personales, o modificarlos si así se desea.

Profile

Como profesor, se puede crear cursos detallando el Nombre, Duración, Frecuencia, Tipo de Clase, Precio, Descripción y subir una imagen que represente a la materia.

Creacion de un Curso

Una vez creado, el profesor puede ver el status del curso, lo puede eliminar, modificar o despublicar.

detalle curso

En el caso de los estudiantes, su perfil pueden ver los detalles del curso y solicitar inscribirse en ellos. Cuando lo solcita, se le pide completar cierta información como el teléfono, email, horario de contacto y el motivo de interés.

solicitud_inscripcion

Una vez el estudiante realiza dicha solicitud, ésta es enviada al profesor para que pueda evaluar si la acepta o la rechaza.

solicitud_final

Si el estudiante es aceptado en un curso, podrá visualizar los cursos en los que esta inscripto y además, tendrá la opción de finalizarlo.

cursos_alumno

Y una vez el curso esté finalizado, el alumno va a poder dejar un comentario y calificarlo.

comentarios

El estudiante también tendrá la opción de ver los comentarios que realizó anteriormente y podrá modificarlos o eliminarlos.

mis_comentarios

En caso de que el usuario necesite recuperar su contraseña, podrá hacerlo. Para ello, se le pedirá su mail y a continuación, recibirá un correo en su casilla con la opción para cambiar la contraseña.

cambiar_contraseña

Y luego, el sistema mostrará un mensaje indicando que se ha cambiado la contraseña de forma existosa.

Documentacion

Diagrama de estructura de la base de datos de MongoDB:

modelo

Documentacion de Postman

https://documenter.getpostman.com/view/17356630/2s8YsnYwim

About

Back End

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published