mayankraj23 / gymkhana_portal

Gymkhana Portal

Web portal and forum for Students' Gymkhana of IIT Jodhpur

Purpose

Simplify the workflow of updating the gymkhana website without much knowledge on how to code. And also provide certain utility features.

This project includes:

• A main web portal which can be updated dynamically through an admin interface.
• A forum/discussion app for general purpose discussions.
• An app called Konnekt to find/search people with a certain required skill set.

Installation:

Requirements:

• Python 3 runtime
• Django 2.0.4
• Other dependencies in requirements.txt

Procedure:

• Install python in your environment(pre-installed on Ubuntu).
• Navigate to the cloned repository.

  cd <project_directory_name>     # gymkhana_portal
  

• Create a new virtual environment and activate it.

  sudo apt-get install -y python3-venv
  python3 -m venv gymkhana_venv
  source gymkhana_venv/bin/activate
  

• Use pip to install other dependencies from requirements.txt

  pip install -r requirements.txt
  

• Change to src directory

  cd src
  

• Make database migrations

  python manage.py makemigrations --settings=gymkhana.settings.dev
  python manage.py migrate --settings=gymkhana.settings.dev
  

• Create a superuser

  python manage.py createsuperuser --settings=gymkhana.settings.dev
  

• Download the static.zip from #gymkhana on Slack and extract the contents under src/static
  Note: This project uses proprietary UI assets, which cannot be shared on GitHub. However you may use free version of mdbootstrap as an alternative. Some things may not look as intended.
• Run development server on localhost

  python manage.py runserver --settings=gymkhana.settings.dev