imclab / kujua-lite

Kujua Lite is a web based SMS data collection and analytics tool focused on community health care workers in rural environments.

Kujua Lite

These instructions should help you get setup to run or develop on Kujua Lite. For latest changes and release announcements see the change log.

Dependencies

You will need to install the following:

Node and CouchDB

Assuming you have Nodejs, CouchDB, and couchdb-lucene.

Kanso

Kanso is required to build and deploy Kujua Lite.

npm install kanso -g

Develop

Push the couchapp:

git clone --recursive https://github.com/medic/kujua-lite
cd kujua-lite
kanso push http://admin:pass@localhost:5984/kujua-lite

Start kujua-sentinel:

cd sentinel
export COUCH_URL=http://admin:pass@localhost:5984/kujua-lite
node ./server.js

Navigate your browser to:

http://localhost:5984/kujua-lite/_design/kujua-lite/_rewrite/

Deploy to Market

When deploying to market include the sentinel package in the couchapp so gardener can manage the process.

First clone the repo recursively so you get both submodules json-forms and sentinel, then change directories:

git clone --recursive https://github.com/medic/kujua-lite
cd kujua-lite

Then edit kanso.json and add "kanso-gardener":null to the end of the list of dependencies. You can use your editor but jsontool has an edit mode that works to:

cat kanso.json |json -e 'dependencies["kanso-gardener"] = null;' > new.json
mv new.json kanso.json

Finally push to the Medic Test Garden Market run:

kanso push http://dev.medicmobile.org:5984/market/_design/market/_rewrite/upload`

Configure

Dashboard is required to load kujua-lite. To install Dashboard

1. git clone https://github.com/garden20/dashboard
2. cd dashboard
3. kanso push $COUCH_URL
4. change the couch db configuration secure_rewrites to false.

See Kujua Sentinel for more information.

Tests

Tests are run in browser, you can run them manually if you browse to /test after a push. To run them from commandline you will need to install phantomjs.

npm install phantomjs -g
./scripts/phantom_test.sh http://localhost:5984/kujua-lite

Help

Join our Google Group or file an issue on Github.

Build Status

Builds brought to you courtesy of Travis CI.

Develop	Testing	Master

License & Copyright

Copyright 2013 Medic Mobile, 501(c)(3) [email protected]

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.