Dokomo どこも Forms is a mobile data collection technology that doesn't suck.
-
Install PostgreSQL, the contributed packages, PostGIS, and the PostgreSQL server development packages:
sudo apt-get install postgresql postgresql-contrib postgis postgresql-server-dev-all
(or whatever the command is on your distribution)
You may also need to install a package like postgresql-X.Y-postgis-scripts (check your repositories).
Debian users: update your apt sources according to this guide else you will pull your hair out wondering why CREATE EXTENSION "postgis"; fails.
-
$ pip-python3 install -r requirements.txt(or whatever the command is on your distribution) -
Create a "doko" database (or whatever other name you want) and a system user (if desired -- the postgres default user should work fine) with access to that database.
-
Edit your dokomoforms/local_settings.py file with the correct PostgreSQL
CONNECTION_STRING(see dokomoforms/settings.py).If you run manage_db.py as user postgres (and because of the extension creation commands, you basically have to), here is how to change the postgres database (as opposed to unix user) password:
# sudo su - postgres $ psql
psql (9.3.5) Type "help" for help.
postgres=# \password postgres Enter new password: Enter it again: postgres=# \q
Now, run the next command (number 5) as unix user <tt>postgres</tt>.
5. `$ python3 manage_db.py --create`
6. `$ python3 webapp.py`
**Note that if `debug` is `True` in the `webapp.py` `config` variable, Anyone can log in as any user. DO NOT SET `debug` TO `True` IN PRODUCTION. Likewise, `APP_DEBUG=true` in local_settings.py sets the `debug` flag to `True`.**
**Finally `TEST_USER=USER` in local_settings permanently logs user USER in for everyone, DO NOT SET THIS IN PRODUCTION.**
# Running the tests
1. `$ pip-python3 install nose coverage selenium`
2. `$ nosetests -c tox.ini`
* **Note:** Selenium tests involve browser windows popping up. If this causes issues on your machine or you'd just prefer for that not to happen, install [Xvfb](http://en.wikipedia.org/wiki/Xvfb) and use this command instead: `xvfb-run nosetests -c tox.ini`
## Running Selenium tests on Sauce Labs
In order to make it easier to test across devices and browsers, you can run the Selenium tests on Sauce Labs.
1. Sign up for an account at [saucelabs.com](https://saucelabs.com/)
2. Install and run sauce-connect: https://docs.saucelabs.com/reference/sauce-connect/
3. Using your username and access key from Sauce Labs, edit your dokomoforms/local_settings.py file like so:
SAUCE_CONNECT = True SAUCE_USERNAME = 'username' SAUCE_ACCESS_KEY = 'access key' DEFAULT_BROWSER = 'firefox::Linux'
4. `$ nosetests tests.selenium_test`
# Local Dev Environment via Vagrant
A [Vagrant](http://vagrantup.com) configuration is provided in order to get the application up and running quickly for local development. Vagrant creates a virtual machine, installs all of the necessary dependencies, and prepares the database to run Dokomo. **At present you must have [Virtualbox](https://www.virtualbox.org/) installed, as it is used as the virtual machine provider by Vagrant.**
1. Make sure you have Virtualbox and Vagrant installed.
2. After cloning the repo, `cd` into the root directory and run `vagrant up`.
3. The first time it's run, vagrant will download the appropriate virtual machine image and provision it -- this process may take several minutes depending on your network connection and cpu.
4. Once it's complete, you can ssh into the virtual machine by running `vagrant ssh`.
5. The root directory of the application on your host machine is shared with the virtual machine's '/vagrant' directory. So once you've ssh'd in, you can navigate to `/vagrant` and start the application: `python webapp.py`