Skip to content

ritstudentgovernment/chargeflask

Repository files navigation

chargeflask Build Status codecov

Flask implementation of RIT Charge Tracker server.

The web client for this project can be found at chargevue.

Building Containers

Prerequisites: Flask and PostgreSQL

  1. Install Docker and Docker Compose
  2. Pull project from this repo.
  3. Copy the template.env file at the root of the project to .env and fill out the environment variables.
  4. Run docker-compose up from the root project directory.

If you have a Mac, you will have to create the folders /chargeflaskdata, chargeflaskdata/postgres-data, chargeflaskdata/redis-data and give Docker permission to these folders.

To ensure that all the containers are running, simply run docker ps you should have an output similar to the following:

CONTAINER ID        IMAGE                     COMMAND                  CREATED             STATUS              PORTS                    NAMES
0c2e1f4c7cb7        chargeflask_huey_worker   "sh -c 'python postg…"   39 seconds ago      Up 38 seconds                                chargeflask_huey_worker_1
db670f5e1f39        chargeflask_flask         "sh -c 'python postg…"   25 hours ago        Up 38 seconds       0.0.0.0:5000->5000/tcp   chargeflask_flask_1
cd810b6790c1        redis:alpine              "docker-entrypoint.s…"   27 hours ago        Up About an hour    6379/tcp                 redis
dc1320d2b173        chargeflask_postgres_db   "docker-entrypoint.s…"   27 hours ago        Up About an hour    5432/tcp                 postgres

Shibboleth Setup

  1. Create a certificate pair inside the folder saml/certs by executing openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout sp.key -out sp.crt
  2. Modify saml/settings.json and saml/advanced-settings.jsonto your IDP and SP settings.

About

Flask implementation of RIT Charge Tracker

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages