Skip to content
This repository has been archived by the owner on Jan 22, 2022. It is now read-only.

Latest commit

 

History

History
62 lines (46 loc) · 2.41 KB

README.md

File metadata and controls

62 lines (46 loc) · 2.41 KB
Raw

Cognizance Club Management System (CCMS)

Django Security Check CodeQL

Club Management System (CMS) is django-based web-app which is specially made for our club.

Screenshot

Installation Instructions

The portal is primarily a django based application, and to set it up we require to have python environment with django and other project dependencies installed. Though one can work with the project without an virtual environment, it is recommended to use one so as to avoid conflicts with other projects.

  1. Make sure that you have Python 3, python-3-devel, gcc, virtualenv, and pip installed.

  2. Clone the repository

        $ git clone https://github.com/cognizance-amrita/cognizance_cms.git
    $ cd cognizance_cms

  3. a. Docker image (First option)

        $ docker-compose build  
    $ docker-compose up

    b. Create a python 3 virtualenv, activate the environment and Install the project dependencies. (Second option)

        $ virtualenv -p python3
    $ source bin/activate
    $ pip3 install -r requirements.txt

You have now successfully set up the project on your environment.

After Setting Up

From now when you start your work, run source bin/activate inside the project repository and you can work with the django application as usual -

  • python3 manage.py migrate - set up database
  • python3 manage.py createsuperuser - create admin user
  • python3 manage.py runserver - run the project locally

Make sure you pull new changes from remote regularly.

Contributors