ContriHUB - 21

ContriHUB is an event where we are expecting to get more and more people involved in Open Source activities.

How to run locally?

• Install Python

• Clone this repository

  git clone https://github.com/ContriHUB/ContriHUB-21.git
  

• Create Virtual Environment

  python -m venv <env_name>
  

• Activate the environment

  • On Windows -
    • If you have Scripts folder inside <env_name>, run: <env_name>\Scripts\activate (in Command Prompt)
    • If you have bin folder inside <env_name>, run: <env_name>\bin\Activate.ps1 (in Powershell).
  • On POSIX (Linux/Mac), run: source <env_name>/bin/activate

• Change directory to ContriHUB-21

  cd ContriHUB-21
  

• Install the dependencies

  pip install -r requirements.txt
  

• Create a .env file

  • In Windows, Right Click, Open Git Bash here, and run: touch .env
  • In Linux/Mac, run: touch .env

• Fill the contents of .env by following the format given in sample_env_file.txt

  • You can use this to generate SECRET_KEY, otherwise just remove that from .env file and it should work fine.
  • You will need to create a Github OAuth App in order to fill SOCIAL_AUTH_GITHUB_KEY and SOCIAL_AUTH_GITHUB_SECRET fields.
  • Put both Homepage URL and Authorization callback URL as http://127.0.0.1:8000/.
  • If you want to work on Email Sending Issue, you also need to fill you Email (GMail) in EMAIL_HOST_USER and your Email password in EMAIL_HOST_PASSWORD. (Now you know why you should never push .env file to remote).
  • You will also need to Allow Access to Less Secure Apps in your GMail Account.
  • You can also create a new GMail account to avoid using your personal account.

• To apply the migrations run,

  python manage.py migrate
  

• Now to run the server, and visit http://127.0.0.1:8000/.

  python manage.py runserver
  

• To access admin panel, you need to be superuser. Follow this link for instructions.

Mentors

You can reach out to us if you need help.

• Ankit Sangwan
• Kshitiz Srivastava

CAUTION: Website is currently under development.