Skip to content

Latest commit

 

History

History
62 lines (60 loc) · 2.26 KB

README.md

File metadata and controls

62 lines (60 loc) · 2.26 KB

Gymkhana Portal Status active Django 2.1.5 Python 3.6

Build Status

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.6 runtime
  • Django >= 2.1.6
  • Other dependencies in Pipfile

Procedure:

  • Install python in your environment(pre-installed on Ubuntu).
  • Navigate to the cloned repository.
    cd <project_directory_name>     # gymkhana_portal
    
  • Install pipenv for dependency management
    pip install pipenv
    
  • Copy .env.example to .env
    cp .env.example .env
    
  • Use pipenv to install other dependencies from Pipfile
    pipenv install --dev
    
  • Activate the new virtual environment
    pipenv shell
    
  • Change to source code directory
    cd src
    
  • Make database migrations
    python manage.py makemigrations
    python manage.py migrate
    
  • Create a superuser
    python manage.py createsuperuser
    
  • 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 
    

DummyData for Testing [OPTIONAL]:

This will populate the database with random values for testing.

python manage.py createfixture