akanimesh/alumni

Alumni Portal for IIITDM Jabalpur

IIITDM Alumni Connect

This web-application aims to facilitate the Alumni Affairs of IIITDM Jabalpur. Please read contributing guidelines before starting.

Requirements

• Python: 3.7/3.8
• Django: 2.2.20
• And additional requirements are in requirements.txt. These will automatically be installed with below steps.

How to run it?

• Fork the repository.
• Clone the repository to your local machine $ git clone https://github.com/<your-github-username>/alumni.git
• Change directory to alumni $ cd alumni
• Add a reference to the original repository $ git remote add upstream https://github.com/Student-Alumni-Connect/alumni.git
• Install virtualenv $ pip3 install virtualenv
• Create a virtual environment $ virtualenv env -p python3
• Activate the env: $ source env/bin/activate (for linux) > ./env/Scripts/activate (for Windows PowerShell)
• Install the requirements: $ pip install -r requirements.txt
  Note: If some requirement causes some error, remove the version from that requirement (ex. convert anyjson==0.3.3 to anyjson) and run the above command again.
• Make migrations $ python manage.py makemigrations
• Migrate the changes to the database $ python manage.py migrate
• Run the server $ python manage.py runserver
• Create admin $ python manage.py createsuperuser
• Create tables $ python manage.py migrate --run-syncdb

Contributing

• Create a new branch with a related name of the motive. Branch name should follow these conventions.
  • feature/* if you're implementing a new feature or adding some new functionality.
  • refactor/* if you're refactoring code or upgrading anything.
  • bug/* if you've fixed a bug that's not deployed onto Production yet.
  • hotfix/* if you've fixed a bug that is deployed and/or causing problems in Production.
  • Note: DON'T push to master or release branch.
• Use an IDE linter, like SonarLint, to fix common bugs/code quality issues.
• Update your task's status in the provided spreadsheet.
• Send a pull request anytime :)