About

This project aims to apply few styling on the web application that displays the agenda of Telecom Nancy.

All credits for the development of the original application goes to Teddy Valette.

Front-end Configuration

Please note that you have to set up the right configuration (hostname, port, endpoint url) in the js/index.js file.

Backend (Annotation API)

The backend/ directory contains a small REST api endpoint that allows to store annotations on calendar events.

The following routes are available:

• GET /api/v1 to get the endpoint status
• GET /api/v1/annotations to retrieve all annotations
• GET /api/v1/annotations/<string:event_id> to retrieve a single annotation
• DELETE /api/v1/annotations/<string:event_id> to delete a specific annotation
• POST /api/v1/annotations/<string:event_id> to create/update an annotation

Installation and Configuration

Hostname and port of the server can be configured in the ./instance/config.py file. You can also configure the sqlite database filename. You must configure JWT_SECRET_KEY, and API_USERNAME/API_PASSWORD.

# to create a virtual environnement
python3 -m venv venv
# to activate the virtual environnement
source venv/bin/activate

# to install dependencies (only Flask, Flask-JWT-Extended and SQLiteDict at the moment)
pip3 install -r requirements

# to run the 'development' server
python3 server.py