Club Management System of amFOSS, powered by CMS
Club Management System (CMS) is django-based web-app which lays framework for the amfoss website, the amfoss webapp, and the amfoss app.
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.
Clone the repository
$ git clone https://github.com/amfoss/cms.git $ cd cms
Create a python 3 virtualenv, and activate the environment.
bash $ virtualenv -p python3 . $ source bin/activate
Install the project dependencies from
$ pip install -r requirements.txt
You have now successfully set up the project on your environment. If you encounter any problems during installation, you can refer to installation page on our wiki.
From now when you start your work, run
source bin/activateinside the project repository and you can work with the django application as usual -
python manage.py migrate- set up database
python manage.py createsuperuser- create admin user
python manage.py runserver- run the project locally
Make sure you pull new changes from remote regularly.
The activity app tracks the activities of the club members.
The members app manages the profile and data of the club members
The status app manages the reporting system in the club
The amFOSS CMS ships with GraphQL-based APIs. To help developers, GraphiQL, a tabbed interface (playground) for editing and testing our GraphQL queries/mutations, also has been furnished .
Documentation on the supported APIs has been provided in the wiki page.
Developed with :hearts: by the amFOSS WebTeam from 2018.
This repository is licensed under GNU General Public License V3. Though it was tailor-made for amFOSS, you are welcome to adapt it, make it yours. Just make sure that you credit us too.