Skip to content

Sanji515/gymkhana_portal-1

 
 

Repository files navigation

Gymkhana Portal Status active Django 2.0.4 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 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
    
  • Copy .env.example to .env
    cp .env.example .env
    
  • Change to src 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 

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 41.8%
  • CSS 39.2%
  • Python 18.4%
  • JavaScript 0.6%