Setup and Installation

Step 1: Python Virtual Enviornment

Note: Python 3.6 is assumed. Check your python version with python --version

If you don't have virtualenv (it comes with python3 on some systems), install it with pip install virtualenv

Change to a directory where you want the teamwork-project directory to reside (e.g. cd Documents/)

Create a new venv (this will create a new folder with python installed and later django/dependencies)

$ virtualenv my_venv

For "my_venv" you can choose whatever name you'd prefer

Now cd into my_venv, or whatever you chose to name your virtual environment, and activate it

$ source bin/activate

For windows: cd into my_venv/Scripts and run activate.bat

Note: you'll have to activate the venv anytime you want to work on this project. Consider adding an alias to your .bash_profile or .bashrc

alias tw="cd ~/Documents/my_venv && source bin/activate"

You can always exit the venv with deactivate

Step 2: Cloning the Repo

Optionally fork the teamwork-project repo. Clone it into the venv folder you just created.

Step 3: Make a .env file based on .env.example

You can find the example for windows and linux/mac in my_venv/grepthink/etc. This can be copy pasted but you will want to change the DATABASE_URL value and the name of the file to be ".env".

The .env file should be in the my_venv folder which will be above the teamwork-project folder.

This is so we can keep the secret key hidden.

It also allows us to use sqlite locally and postgres in production.

For local develompent, your DATABASE_URL can be something like: DATABASE_URL=sqlite:////Users/sammyslug/Documents/my_venv/teamwork-project/teamwork/db.sqlite3

Be sure your path is correct; it is easy to mess up.

The .env file should be in /my_venv/teamwork-project

Step 4: Install dependencies

Make sure you're in your venv then install everything in requirements.txt

$ pip install -r requirements.txt

Step 5: Database Initialization

Now you will have to make the appropriate tables in your database using

python manage.py makemigrations auth courses profiles projects

and then you can migrate these migrations using python manage.py migrate

Step 6: Running the server

You can run the server using python manage.py runserver