metakgp / gyft-serve

[Moved to gyft] Webapp for GYFT
https://gyft.metakgp.org
4 stars 9 forks source link
hacktoberfest

gyft-serve

Flask frontend for gyft

Website at https://gyft.metakgp.org/

gyft is located at metakgp/gyft

This would download your timetable.ics file, import to Google Calendar by following this link.

Demo

placeholder

Development & Deployment

Running Locally

Please follow the following steps to run the application locally.

NOTE: The instructions assumes that you are using a linux system (specifically Debian based distribution).

First Time Setup

  1. Clone the repository git clone https://github.com/metakgp/gyft-serve
  2. Change directory to the clone repository.
  3. Install Python3.7
  4. Install pipenv

Running In Virtual Environment

  1. Run pipenv shell (to create a virtual environment for the program)
  2. Run pipenv install --dev (to install all the dependencies)
  3. Run gunicorn app:app --log-file=- (to launch the application)

What To Do Every Sem?

We need to updates dates.py every semester.

This repository just serves as a frontend for original Gyft and is mostly maintained alongside updates to the original repository.

Deployment

The application is deployed on the metakgp digital ocean droplet. The deployment is done using docker-compose alongside nginx as a reverse proxy. We use the external network metakgp-wiki_main_network to connect with the nginx container of the wiki.

Refer the nginx configuration details - https://github.com/metakgp/metakgp-wiki/tree/master/nginx

After an update using git pull, run docker-compose up --force-recreate --build -d to update the application in the directory /root/gyft-serve.