Running the server

This is a quick guide for getting your development server running after you've completed the setup process.

Docker

Run docker-compose

# Move to your Ubyssey project dir
cd ~/ubyssey-dev
# Start docker containers
docker-compose up

macOS

First, open a new Terminal window.

Start your MySQL server if it isn't running already:

mysql.server start

Change into the ubyssey-dev directory (the location depends on where you saved it):

cd ~/ubyssey-dev

Activate the virtual environment:

source bin/activate

Change into the ubyssey.ca directory:

cd ubyssey.ca

Run the server!

python manage.py runserver

Building the static files

Now, select Shell > New Tab from the Terminal menu bar. This will open a new shell in the ubyssey.ca folder.

From this folder, navigate to ubyssey/static

cd ubyssey/static

Start the gulp script, which watches for changes to your source files and rebuilds all the static assets:

gulp

If you need to cancel the gulp script, simply press control + c.

Windows

First, make sure your MySQL server is running. The easiest way to do this is with MySQL Workbench.

Next, open a new Command Prompt window and change into the ubyssey-dev directory.

cd ubyssey-dev

Activate the virtual environment:

.\Scripts\activate

Change into the ubyssey.ca directory:

cd ubyssey.ca

Run the server!

python manage.py runserver

Building the static files

Now, open a new Command Prompt window and navigate to the static files directory:

cd ubyssey-dev/ubyssey.ca/ubyssey/static

Start the gulp script, which watches for changes to your source files and rebuilds all the static assets:

gulp

If you need to cancel the gulp script, simply press control + c.