Skip to content
This repository has been archived by the owner on Jan 4, 2018. It is now read-only.
/ AcademicalService Public archive

Microservice for the academical calendar part of the HTWK-App

License

Notifications You must be signed in to change notification settings

HTWK-App/AcademicalService

Repository files navigation

AcademicalService

Build Status License Language Language Framework Lines of Code

This microservice scrapes the academical calendar of the University of Applied Sciences Leipzig and provisions it through a REST-JSON API.

The data is fetched, cleaned and enhanced every 24 houres to ensure latest updates.

Using this Service

Once your Server is running all you need to do is open your browser pointing to the host/port you just published and look at the raw JSON-data. The default Port is 9000, so you got to call:

http://localhost:9000/academical/{ws|ss}

in a Webbrowser.

To play with the REST API, point your browser at http://localhost:9000/documentation.

Compilation/Running the Server

Install NodeJS.

To start the server (for the first time), execute the following commands:

# May take some time
npm install
npm start

Please note that this application was designed to be deployed with docker and instrumented (Metrics, ...) by NewRelic. Inside the projects root, you'll find a Dockerfile that describes this setup.

docker build -t academical ./
docker run -it --rm -p 9000:9000 academical:latest

About

Microservice for the academical calendar part of the HTWK-App

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published