This documentation repo has been replaced by cht-docs

Check out the new documentation site: docs.communityhealthtoolkit.org

Documentation

Core Framework Development

The following guides should help orient developers interested in the Core Framework used to build community health apps. Setting up the Core Framework itself is covered in the cht-core repo.

How we work

• Developer environment setup
• Using Git
• Using npm
• Our workflow
• Culture
• Style guide
• Updating translations
• Releasing our app

Technical overviews

• Architecture
• DB schema
• Message states
• User telemetry
• How to migrate dashboard to SSL
• Data flow management for analytics and dashboards

Building community health apps

An introduction and reference for building community health apps is provided in Developing Community Health Apps. This overview covers building forms, tasks, targets, and contact profiles.

Read more about building apps with the Core Framework, and using other components.

Maintenance, support, and troubleshooting

• Release notes
• Software compatibility matrix
• Troubleshooting - Quick Pointers and Tips
• Dealing with conflicts
• Replicating production data locally
• Obtaining production logs

License

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