SIASE API

Un REST API de código abierto que proporciona los datos de SIASE

Acerca del proyecto

• Documentación

SIASE API es un REST API de código abierto que utiliza webscraping para obtener los datos de la plataforma de SIASE de la UANL, con esta api podrás acceder a tu información como las carreras que estas cursando, los horarios e incluso consultar tu kardex.

Puedes utilizar esta API para construir cualquier proyecto que desees o contribuir para mejorarla.

SIASE API y el GDSC no estamos afiliados de ninguna manera con la UANL, este es un proyecto hecho por y para estudiantes.

Errores, mejoras y contribuciones

Por favor asegurate de leer las guías de contribución.

Issues

1. Antes de reportar un issue por favor echa un vistazo a los issues abiertos.
2. Si tienes alguna duda puedes preguntar en nuestro Discord

Bugs

• Incluye los pasos para reproducir
• Incluye screenshots si es necesario

Feature requests

• Escribe una explicación detallada, donde se menciona que es lo que se debería de hacer y como.
• Incluye screenshots si es necesario
• Ten en cuenta que estamos limitados a las capacidades de la plataforma de SIASE

Contribuciones

Por favor mira nuestro apartado de contribuciones

💻 Herramientas de desarrollo

NodeJS

TypeScript

Express

Cheerio

Axios

JWT

Iniciar un servidor local de desarrollo

Antes de clonar el repositorio asegurate de tener instalado:

• NodeJS

• NPM

• Una vez que hayas descargado el repositorio instala las dependencias utilizando

  npm install

• Crea un archivo .env en el directorio principal y llenalo con las variables necesarias. Puedes ver las variables requeridas en el archivo EXAMPLE.env.

• Ejecuta el servidor utilizando

  npm run build && npm run start

✍ Colaboradores

Fmaldonado6

David-Lazaro-Fernandez

FabianCruz-0

rtrevinnoc

Contact

GDSC UANL - @dscuanl - [email protected]