- Introduction
- Project Structure
- Pre-requisites
- Getting started
- Running the app
- Building
- Testing
- Deployment
Bottleneck analysis (BNA) is a structured analysis of the determinants of coverage for a wide range of interventions delivered through the health sector, useful to supporting targeted operational planning. It is a systematic, outcome-based approach to equitable health programming and real-time monitoring that strengthens the health system, complementing and building on what exists.
The BNA App is developed and maintained by the HISP Community (UiO, HISP-Tanzania and HISP Uganda) in collaboration with UNICEF.
The project is divided into 4 main modules:
This module include all intervention viewing and analysis features. It's sub-modules include:
- Intervention Header: Lists all the accessible interventions
- BNA chart (Analysis chart): View of the Determinants in a bar chart
- Sub-Level analysis: Has 3 parts, Sub level table analysis, Sub level map, and Indicator dictionary for the configured determinants
- Root cause analysis: Allows management of root causes based on the configured determinants.
This module includes all intervention configuration features. This is done in 3 steps:
- Step 1: Includes name, period, organisation unit, legend definitions, and map configuration
- Step 2: Includes determinants selection and configuration
- Step 3: Includes sharing settings
This module contains the archiving feature. It allows view and management of archived interventions.
This module contains features that allow auto-migration of intervention configuration from the previous BNA versions to the new version.
This project was bootstrapped with DHIS2 Application Platform. To start development you require:
- Node - 16.x or later
- Yarn - 1.22.19 or later
To get started with the project, clone the project into your local environment
git clone https://github.com/hisptz/bottleneck-analysis-appThen open your project and run:
yarn installTo start the app in development mode run:
This command runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
To avoid having to specify the server URL everytime you start the app, you can duplicate the .env.example file and
rename it to .env. Then change the REACT_APP_DHIS2_BASE_URL variable to the URL of your DHIS2 instances
When running in development mode, you may encounter CORS error. To fix this issue, proxy your DHIS2 instance by
appending --proxy http://link-to-dhis2-instance to the start command. This will start a local proxy server
at http://localhost:8080 (It may change ports if 8080 is busy)
. You can then point your app to http://localhost:8080
To build your app ready for production run:
This command builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
A deployable .zip file can be found in build/bundle!
See the section about building for more information.
In the project directory, you can run:
Launches the test runner and runs all available tests found in /src.
See the section about running tests for more information.
To run end-to-end testing, use:
To open the cypress test runner or use:
To run the tests without opening the runner
Deploys the built app in the build folder to a running DHIS2 instance.
This command will prompt you to enter a server URL as well as the username and password of a DHIS2 user with the App
Management authority.
You must run yarn build before running yarn deploy.
See the section about deploying for more information.