platypi ~ REST platform

Getting Started

Prerequisites

• VirtualBox
• Docker Compose (or get Docker Toolbox instead)
• Docker Machine (or get Docker Toolbox instead)
• Install virtualenv with pip3

Initialize virtualenv

virtualenv -p python3 .venv && source .venv/bin/activate && pip install -r requirements.txt

This command creates a virtual environment within the .venv directory to isolate the project's python dependencies from your potentially-janky python libraries on your local machine. After creation, it activates the virtualenv and installs the dependencies within.

After creating this virtualenv, going forward you only need to use source .venv/bin/activate to start executing python commands within this isoalted environment.

Light 'er up

Assuming you followed the docker engine installation instructions, you should be able to get things started.

1. Spin up the VM docker-machine create -d virtualbox platypi

• This VM should show as 'inactive' when you run docker-machine ls

2. Attach Docker to the VM eval "$(docker-machine env platypi)"

• This should now show the docker-machine as 'active' when you run docker-machine ls

3. Build the docker container(s) docker-compose build
4. Start up the services docker-compose up -d
5. Get the VM's IP address docker-machine ip platypi and hit it in the browser http://IPADDRESS (or map a hostname to the IP in your /etc/hosts file

NOTE: The DB is not currently hooked up, but the UI looks pretty.