homely-webapp

Homely RESTful webapp for c4tk

Getting Started

These instructions should work on Ubuntu 15.04 (Vivid Vervet) and Mac OS X Yosemite. I can't vouch for other *nix OSes.

I couldn't get this to work on Windows, so if you're on Windows (as I often am) I suggest you run Ubuntu in VirtualBox.

Pre-Requisites

1. Python 2.7+ or Python 3.4+
2. The Python developer package on Linux. Get it with sudo apt-get install python-dev on Ubuntu or a similar, appropriate command for your Linux distro (such as sudo yum install python-devel on CentOS).
3. pip
4. virtualenv

Installation steps

Setting up Python

1. Clone the repository.
2. In a terminal window in your local copy of the repo, create a virtual environment with virtualenv venv.
3. Activate the virtual environment with source venv/bin/activate.
4. Install the required packages with pip install -r requirements.txt.

Setting up PostgreSQL locally

1. Download and install PostgreSQL server for your platform.
2. Start postgres.
3. Using the terminal or pgadmin:
4. Create a user pyhomely with password pyhomely.
5. Create a database homely owned by that user pyhomely.
6. Make a file called homely/local_settings.py. The easiest way to do that is to copy homely/local_settings.py.template, rename the copy to local_settings.py, and edit it as you need to.
7. Run python manage.py migrate to setup the db.
8. You might also want to create a super user for use in the admin console and rest interface with python manage.py createsuperuser.
9. Go to http://localhost:8000/api/ to see the api running locally on your machine!