A django app for monitoring rivers and river health.
View a running instance at http://healthyrivers.kartoza.com
Note that HealthyRivers is under development and not yet feature complete.
The latest source code is available at https://github.com/kartoza/healthyrivers.
- Developers: See our developer guide
- Designers: See our Moqups Project for design moqups.
- For production: See our deployment guide
- To be added
Story queue on Waffle:
-
Current test status master:
and
-
Current test status develop:
and
For deployment we use docker so you need to have docker running on the host. HealthyRivers is a django app so it will help if you have some knowledge of running a django site.
git clone git://github.com/kartoza/healthyrivers.git
cd healthyrivers/deployment
cp btsync-db.env.EXAMPLE btsync-db.env
cp btsync-media.env.EXAMPLE btsync-media.env
make build
make permissions
make web
# Wait a few seconds for the DB to start before to do the next command
make migrate
make collectstatic
If you need backups, put btsync keys in these files. If you don't need backups, you can let the default content.
So as to create your admin account:
make superuser
intercom.io
If you wish to make use of intercom.io, include a
private.py file in core.settings with your INTERCOM_APP_ID as a string.
The necessary code snippet is already included in project_base.html.
google authentication
In social auth to use the google authentication you need to go to:
https://console.developers.google.com/apis/credentials
Create and oath2 credential with these options:
Authorized redirect URIs
http://healthyrivers.kartoza.com/en/complete/google-oauth2/
Use the HealthyRivers admin panel to set up the google account with your id and secret
github authentication
Create a developer key here:
https://github.com/settings/applications/new
Set the callback and site homepage url to the top of your site e.g.
At http://localhost:61202/en/site-admin/socialaccount/socialapp/add/
Set the key and secret from the github key page.
Backups
If you wish to sync backups, you need to establish a read / write btsync key on your production server and run one or more btsync clients with a read only key.
cd deployment
cp btsync-media.env.EXAMPLE btsync-media.env
cp btsync-db.env.EXAMPLE btsync-db.env
Now edit the btsync-media.env and btsync-db.env files, including
relevant SECRET and DEVICE settings.
We work under the philosophy that stakeholders should have access to the development and source code, and be able to participate in every level of the project - we invite comments, suggestions and contributions. See our milestones list and our open issues list for known bugs and outstanding tasks. You can also chat live with our developers and community members using the link below.
HealthyRivers was funded by JRS and developed by Kartoza.com, Freshwater Research Center and individual contributors.
HealthyRivers is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License version 3 (GPLv3) as published by the Free Software Foundation.
The full GNU General Public License is available in LICENSE.txt or http://www.gnu.org/licenses/gpl.html
There is no warranty for the program, to the extent permitted by applicable law. Except when otherwise stated in writing the copyright holders and/or other parties provide the program "as is" without warranty of any kind, either expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The entire risk as to the quality and performance of the program is with you. Should the program prove defective, you assume the cost of all necessary servicing, repair or correction.
Thank you to the individual contributors who have helped to build HealthyRivers:
- Christian Christelis (Lead developer): christian@kartoza.com
- Tim Sutton (Lead developer): tim@kartoza.com
- Dimas Ciptura: dimas@kartoza.com
- Irwan Fathurrahman: irwan@kartoza.com
- Anita Hapsari: anita@kartoza.com