cadasta-platform

|build-status-image| |req-status-image|

Install for development

Install:

• VirtualBox <https://www.virtualbox.org/>_
  • Version 5.0.x
• Vagrant <https://www.vagrantup.com/>_
  • Version 1.8.1
  • If you are behind a proxy, you may need to install and configure the vagrant-proxyconf <https://rubygems.org/gems/vagrant-proxyconf/versions/1.5.2>_ plugin
• Ansible <http://www.ansible.com/>_
  • Version 2.2+
  • For Linux and Mac, install Ansible 2 via pip
  • For Windows (unsupported), go through Ansible Documentation <http://docs.ansible.com/ansible/intro_windows.html>_ or this blog <https://www.jeffgeerling.com/blog/running-ansible-within-windows>_

Clone the repository <https://github.com/cadasta/cadasta-platform>_ to your local machine and enter the cadasta-platform directory. Run the following commands to access the virtual machine.

Provision the VM::

vagrant up --provision

SSH into the VM (automatically activates the Python virtual environment)::

vagrant ssh

Enter the cadasta directory and start the server::

cd cadasta ./runserver

To add the Django debug toolbar, use ./runserver --debug.

Open http://localhost:8000/ in your local machine's browser. This will forward you to the web server port on the VM and you should see the front page of the platform site.

See the wiki for details on loading test data <https://github.com/Cadasta/cadasta-platform/wiki/Loading-test-data>_.

Run tests

Within the development VM, from the /vagrant directory run::

py.test cadasta

To get coverage reports run::

py.test cadasta --cov=cadasta --cov-report=html

This creates a HTML report under htmlcov. See pytest-cov docs <http://pytest-cov.readthedocs.org/en/latest/readme.html#reporting>_ for other report formats.

AWS Deployment

Do this::

vagrant box add dummy https://github.com/mitchellh/vagrant-aws/raw/master/dummy.box vagrant plugin install vagrant-aws ...

vagrant up --provider=aws ...

.. |build-status-image| image:: https://secure.travis-ci.org/Cadasta/cadasta-platform.svg?branch=master :target: http://travis-ci.org/Cadasta/cadasta-platform?branch=master .. |req-status-image| image:: https://requires.io/github/Cadasta/cadasta-platform/requirements.svg?branch=master :target: https://requires.io/github/Cadasta/cadasta-platform/requirements/?branch=master

Acknowledgements

Cadasta is grateful for the technical considerations and support provided by:

• BrowserStack <https://www.browserstack.com/>_

• Opbeat <https://opbeat.com>_

• Travis CI <https://travis-ci.com/>_