This project was bootstrapped with DHIS2 Application Platform.
This project uses the DHIS portal for creating a portal from localhost:9999 to course.dhis2.org to prevent cors.
$ dhis-portal --server=course --instance=course --target='https://course.dhis2.org' --auth='username:password'
Install packages and start dev server
$ yarn
$ yarn start
App.js handles the query for the resource - trackedEntityInstances the result is extracted and stored as a state - "clusters". The clusters is then passed through as props to the to main components - Clusters and Map, and rendered. Clusters component consist of a simple search function and a dhis2/ui-core table. Clusters component renders the Accordion component in the body of the table. Accordion is a react memo component which only will re render if props change. This can be a potential speedup. The Accordion component queries relationships, extracts the data and renders a Modal, a TableRow and the map component. The accordions modal renders the ClusterInfo or CasesInfo component based on click events. Clusterinfo contains a table with the persons in the cluster and casesinfo shows more information about a specific person.
When commiting to git husky will check that all files are formatted correctly and that the commit message is on the right format.
Husky commit message validation
Example:
$ git commit -m"fix(server): send cors headers"
When starting a new tast you should make a new branch
$ git checkout -b feat/new-feature
When the feature is done, all test passed and all code is formatted correctly, you can create a pull request.
First be sure that the branch is up to date with master
$ git checkout master && git pull
$ git checkout feat/new-feature
$ git merge master
Resolve potential merge conflicts.
Create the pull request
$ git push origin feat/new-feature
Go to github and publish the pull request.
Make sure to checkout master and delete branch when finished
$ git checkout master && git pull
Check that yarn format runs successfully, this command will format the code and check for linting errors.
$ yarn format
This project uses the @dhis2/cli-app-scripts for linting, prettier and husky
Add a cypress.env.json
| key | value |
|---|---|
| dhis2_base_url | http://localhost:9999 |
| dhis2_username | username |
| dhis2_password | password |
| dhis2_datatest_prefix | dhis2-clustermanagement |
In the project directory, you can run:
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.
Launches the test runner and runs all available tests found in /src.
See the section about running tests for more information.
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.
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.
You can learn more about the platform in the DHIS2 Application Platform Documentation.
You can learn more about the runtime in the DHIS2 Application Runtime Documentation.
To learn React, check out the React documentation.