Skip to content
Medic Mobile's Core Framework makes it faster to build responsive, offline-first digital health apps that equip health workers to provide better care in their communities. It is a central resource of the Community Health Toolkit.
JavaScript HTML CSS Other
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update repo name to cht-core Oct 23, 2019
admin Updates labels on the import and export page (#6085) Nov 12, 2019
api Restricted db-doc optimisation (#6057) Oct 25, 2019
config Update tour labels for consistency (#6107) Nov 13, 2019
ddocs Update tour labels for consistency (#6107) Nov 13, 2019
demo-forms Adds audio to the multimedia demo xml form Sep 23, 2019
grunt Server side form generation Sep 17, 2019
release-notes Adds release notes for 3.7.1 Nov 10, 2019
scripts Make application versions consistent (#6081) Nov 4, 2019
sentinel Add a timeout to outbound requests (#6075) Oct 29, 2019
shared-libs Death reporting uses patient (#6098) Nov 19, 2019
tests Death reporting uses patient (#6098) Nov 19, 2019
webapp Removes debug code left in a test Nov 20, 2019
.auditignore Enables running transitions synchronously (#5476) May 2, 2019
.browserslistrc Rebasing to master (#5292) Jan 29, 2019
.eslintrc Update standard to use medic-conf 3.0 (#5821) Aug 20, 2019
.gitignore Clean up XLSForms (#6006) Oct 10, 2019
.gitmodules Deinit all submodules Oct 24, 2017
.travis.yml Server side form generation Sep 17, 2019
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Aug 13, 2019
CONTRIBUTING.md Update repo name to cht-core Oct 23, 2019
Changes.md Update repo name to cht-core Oct 23, 2019
DEVELOPMENT.md Update Documentation Nov 11, 2019
Gruntfile.js Make application versions consistent (#6081) Nov 4, 2019
INSTALL.md Add easy test data instructions (#6076) Oct 30, 2019
LICENSE Add AGPL license Sep 18, 2018
README.md Updating instructions (#6035) Oct 25, 2019
docker-compose.yml Updating instructions (#6035) Oct 25, 2019
package-lock.json Bump version for 3.8.0 (#6078) Oct 30, 2019
package.json Bump version for 3.8.0 (#6078) Oct 30, 2019

README.md

The Core Framework of the Community Health Toolkit (CHT)

This is the repository of the CHT Core Framework, a technical resource of the Community Health Toolkit (CHT) contributed by Medic Mobile.

Medic Mobile is a nonprofit organization on a mission to improve health in the hardest-to-reach communities through open-source software. Medic Mobile serves as the technical steward of the Community Health Toolkit.

For the latest changes and release announcements see our release notes. Our exact support matrix (including older app versions) can be found in our docs.

Overview

The CHT's Core Framework is a software architecture that makes it faster to build full-featured, scalable digital health apps that equip health workers to provide better care in their communities. To learn more about building an application with the Core Framework, visit our guide for developing community health apps.

The Core Framework addresses complexities like health system roles and reporting hierarchies, and its features are flexible enough to support a range of health programs and local care provider workflows.

Mobile and web applications built with the Core Framework support a team-based approach to healthcare delivery and management. Health workers can use SMS messages or mobile applications to submit health data that can then be viewed and exported using a web application. These web applications are fully responsive with a mobile-first design, and support localization using any written language. They can be installed locally or in the cloud by setting up the individual components or as a Docker container.

For more information about Medic Mobile's architecture and how the pieces fit together, see Architecture Overview. For more information about the format of docs in the database, see Database Schema. For more information about the SMS exchange protocol between webapp and gateway, see Message States.

Using the Core Framework

If you are a developer looking to contribute to the Core Framework itself, you should follow the development setup instructions.

If you wish to evaluate the Core Framework, or you are a developer looking to create or modify applications built with the Core Framework, you can instead follow the easy deployment instructions, which will get the latest stable release running locally via Docker.

You will need to also familiarise yourself with medic-conf, a tool to manage and configure your apps built using the Core Framework. A brief guide for modifying the config is available alongside the config. A more detailed guide is available in medic-docs.

Supported Browsers

Currently, the latest versions of Chrome, Chrome for Android and Firefox are functionally supported. We do not support Safari (unreliable implementations of necessary web APIs) and the generic android browser (unreliable implementations in general). Our webapp code, which includes any code written as configuration, is still ES5. Our exact support matrix (including older app versions) can be found in our docs.

Contributing

The Core Framework of the Community Health Toolkit is powered by people like you. We appreciate your contributions, and are dedicated to supporting the developers who improve our tools whenever possible.

To setup a development environment to contribute to the Core Framework follow the development instructions.

First time contributor? Issues labeled help wanted are a great place to start.

Looking for other ways to help? You can also:

  • Improve documentation. Check out our style guide here
  • Find and mark duplicate issues
  • Try to reproduce issues and help with troubleshooting
  • Or share a new idea or question with us!

The easiest ways to get in touch are by raising issues in the medic Github repo or joining our Community Forum.

For more information check out our contributor guidelines.

Build Status

Builds brought to you courtesy of Travis CI.

Build Status

Copyright

Copyright 2013-2018 Medic Mobile, Inc. hello@medicmobile.org

License

The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license.

You can’t perform that action at this time.