Skip to content

Latest commit

 

History

History
88 lines (65 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

88 lines (65 loc) · 1.39 KB

Getting started


To make contibution on this repository please go through the following steps

  1. Clone this repository to your local machine:
    git clone https://github.com/techhub-community/csoc_platform.git
    cd csoc_platform
  1. Install virtualenv module
    pip install virtualenv
  1. Create a virtual enviornment
    python3 -m venv env_name
  1. Activate the virtual environment
  • On Mac/Linux
    source env_name/bin/activate
  • On Windows
    env_name\Scripts\activate
  1. Install requirements
    pip install -r requirements.txt
  1. Shell Script Permissions
  • On Mac/Linux
    chmod +xwr run_local.sh
    chmod +xwr run_migrations.sh
    chmod +xwr run_commands.sh
  • On Windows
    attrib -r +x run_local.sh
    attrib -r +x run_migrations.sh
    attrib -r +x run_commands.sh 
  1. Script Execution
    ./run_local.sh
    ./run_migrations.sh
  1. Add .env file to the root directory

It's content should be

SECRET_KEY=YOUR_SECRET_KEY
DEBUG=True
EMAIL_BACKEND='django.core.mail.backends.smtp.EmailBackend'
EMAIL_HOST='smtp.gmail.com'
EMAIL_PORT=465
EMAIL_HOST_USER=YOUR_EMAIL_ID
EMAIL_HOST_PASSWORD=YOUR_APP_PASSWORD_FOR_EMAIL
DEFAULT_FROM_EMAIL=YOUR_EMAIL_ID
EMAIL_USE_SSL=True
  1. Run Project
    ./run_commands.sh runserver