Workspace setup

Utility tools and required tools and libraries for project development are listed:

Utility tools:

• Your favourite IDE supporting python (preferred with DJango tools) suggested
• PGAdmin (tools for postgreSQL)

Required tools:

• Python3
• PostgreSQL server (can be installed on local machine or can be deployed locally as a docker container)
• git (version control)
• Docker (virtualization/deployment)
• A SSH client (Putty, Open SSH etc.)

After installing desired and required tools:

1. Clone repo to your local machine - git clone https://github.com/CAKES-coding/swe574-group2
2. Setup using command line or setup using IDE:
   1. Command line:
      • cd into Project/Wikode directory
      • Create a python virtual environment - python -m venv wikode-env
      • Activate virtual environment - win:wikode-env\Scripts\activate.bat linux:wikode-env\bin\activate
   2. IDE:
      • Open IDE
      • Create a new Django project
      • Select Project/Wikode as project folder
      • Setup Python interpreter
3. Install dependencies:
   • At the project root folder - pip install -r requirements.txt (for Mac psycopg2 library wont build use psycopg2-binary)
4. Create a '.env' file:
   • At the same folder with setting.py create a file named .env fill in your application, API and DB information with below keys:

SECRET_KEY={{django_secret}}
DATABASE_NAME={{database_name}}
DATABASE_USER={{database_username}}
DATABASE_PASS={{database_password}}
DATABASE_HOST={{database_host}}
DATABASE_PORT={{database_port}}

5. Try if your server running using manage.py - python manage.py runserver