koosli.org

Search APIs, user autonomy, and good intentions.

Development

Install virtualenv, then:

$ virtualenv venv
$ . venv/bin/activate
$ pip install -r dev-requirements.txt
$ ./manage.py db upgrade
$ ./manage.py runserver

To run the tests:

$ nosetests

Keep test coverage up.

Add a user to the web server by running pcrypt -r 50000 to get your password hash, and encrypt it using tools/secure_data.py. Add the rest of your details to pillar/users/init.sls and Travis will create your user when you push your changes.

Vagrant

To run a full virtual environment, install VirtualBox and Vagrant, add the following to your hosts file:

10.10.10.33 koosli.dev
10.10.10.33 www.koosli.dev

Spin up the vagrant env:

$ vagrant up

Build and deploy the app:

$ python setup.py sdist
$ fab deploy_vagrant

Note: deploy_vagrant is just an alias for deploy with the host configured to vagrant:vagrant@10.10.10.33.

You can now visit the site at https://koosli.dev in your browser. You will receive a security warning due to the connection being secured by an untrusted certificate, make an exception in your browser for the koosli.dev domain, but DO NOT add the cert to your trusted roots, as the private key is public and will be able to compromise your computer if it's in your trust store. Trusting koosli.dev is safe however, as the TLD .dev doesn't resolve outside your own computer, and is thus not vulnerable to MITM attacks.