Heroku App

Heroku App que consume API

• Componentes react: src/assets/js/ApiApplication/
• Vistas: src/views/ApiApplication/
• Controladores: src/routes/ApiApplication/
• Estilo: src/assets/style/ApiApplication.scss

Cuentas

• admin@uc.cl: pass
• student@uc.cl: pass
• professor@uc.cl: pass

Documentación Aplicación

Requisitos:

• PostgreSQL
• Node.js versión>=v12.16
• Yarn

Configuración

• Clonar el repositorio
• Instalar las dependencias con yarn install
• Instalar postgresql y craer una base de datos
• Agregar los datos de las base de datos a src/config/database.js
• Correr las migraciones con ./node_modules/.bin/sequelize db:migrate
• Correr las seeds con ./node_modules/.bin/sequelize db:seed:all

Variables de entorno

• DB_NAME: nombre de la base de datos
• DB_HOST: host de la base de datos
• GOOGLE_APPLICATION_CREDENTIALS: credentials para la API Google Cloud Storage (path)
• UNSPLASH: client ID de la API unsplash

Ejecutar la App

• Para ejecutar de forma normal usar el comando yarn start
• Para ejecutar en modo dev usar el comando yarn dev
• Abrir http://localhost:3000 en el navegador

Soluciones de problemas comunes

• Reinstalar dependencias:
  • Borrar la carpeta node_modules
  • Correr yarn install
• Resetear base de datos:
  • ./node_modules/.bin/sequelize db:migrate:undo:all
  • ./node_modules/.bin/sequelize db:migrate
  • ./node_modules/.bin/sequelize db:seed:all

Arquitectura

La arquitectura es MCV:

• Las rutas de la aplicación y la lógica están en los controladores.
• Lo que se muestra al usuario está contenido en las vistas.
• La interacción con la base de datos, validación de datos, etc, ocurre en los modelos.

Los controladores están en src/routes/ y el controlador principal es src/routes.js.
Las vistas están en src/views/.
Vistas notables:

• layout.html.ejs: La vista principal que contiene otras vistas parciales.
• menu.html.ejs: Una vista parcial que contiene la barra de navegación.
• erros.html.ejs: Una vista parcial que muestra los erroes.

Los models se encuentran en src/models/ con las migraciones asociadas en src/migrations/.
Los componentes react se encuentran src/assets/js/.
Los estilos están en src/assets/styles/.

Modelo de datos

Documentación API

La API está en src/routes/api.
La autenticación se hace con un accessToken.
Para los endpoints que lo requieren se tiene que pasar el token en el header del request con la llave accessToken.
El accessToken se puede obtener haciendo un post a /api/auth con el email y password en el body (form-data).

path	method	descripción	form-data params in body	url-encoded query params	returns	requiere accessToken en header
/api/auth	post	permite obtener un accessToken	email, password		json con accessToken	no
-	-	-	-	-	-	-
/api/universities	get	entrega todos las universidades			json con todas las universidades	no
/api/universities/id	get	entrega universidad con id			json con una universidad	no
/api/universities	post	crea una universidad	code, name, domain		json con link de la universidad	si
/api/universities/id	patch	modifica universidad con id	opcionales: code, name, domain		json con link de la universidad	si
/api/universities/id	delete	elimina universidad con id				si
-	-	-	-	-	-	-
api/courses/	get	entrega todos los cursos			json con todos los cursos	no
api/courses/	get	entrega todos los cursos de una universidad		UniversityId	json con cursos de una universidad	no
api/courses/id	get	entrega curso con id			json con un curso	no
api/courses/	post	crea un curso	code, name, description, UniversityId		json con link del curso	si
api/courses/id	patch	modifica curso con id	opcionales: code, name, description, UniversityId		json con link del curso	si
api/courses/id	delete	elimina curso con id				si
-	-	-	-	-	-	-
api/evaluations/	get	entrega todas las evaluaciones			json con todas las evaluaciones	no
api/evaluations/	get	entrega todas las evaluaciones de un curso		CourseId	json con evaluaciones de un curso	no
api/evaluations/id	get	entrega evaluación con id			json con una evaluación	no
api/evaluations/	post	crea una evaluación	CourseId, ProfessorNameId, year, semester, comment, timeRating, difficultyRating		json con link de la evaluación	si
api/evaluations/id	patch	modifica evaluación con id	opcionales: CourseId, ProfessorNameId, year, semester, comment, timeRating, difficultyRating		json con link de la evaluación	si
api/evaluations/id	delete	elimina evaluación con id				si