This repo contains the dashboards app first released in DHIS2 version 2.29.
It was bootstrapped with Create React App, and later ejected.
To use the dashboards-app in development mode, it is necessary to have a running DHIS2 instance, and be logged in to it. This is because the app requests resources, like react and react-dom, from the DHIS2 core resources. Most developers use their local DHIS2 instance. If you haven't configured your DHIS2_HOME env variable and set up a config.json, then the app will default to using localhost:8080 with the admin user (see config/webpack.config.dev.js).
First clone the repo, then:
yarn install
yarn start
The webpack-dev-server will start up on localhost:3000, by default.
yarn test or yarn coverage
The dashboards-app uses eslint for code correctness checking, and prettier for formatting, and the build will fail if any of the checks fail. To make life easier, we suggest that you add the eslint and prettier plugins to your editor. But if you prefer, you can run the following before pushing your code:
yarn lint
yarn prettify
The dashboards-app uses the d2 library for communicating with the DHIS2 api. And as much as possible, we use d2-ui components, rather than using material-ui directly. Make sure to upgrade these dependencies regularly, and contribute to them.
In order to test the build of the dashboards-app (rather than just the dev server), deploy it to your local dhis2 build. The instructions here assume a good understanding of building DHIS2 locally.
From the root of the dashboards-app, build the dashboards-app locally
yarn build
Then copy the contents of the /build folder to your .m2 directory. Then run:
mvn install
Navigate to your local dhis2 repo, dhis-web-apps directory. Then run
mvn clean install -o
Every commit to master is automatically deployed. To deploy a build to an older dashboards-app version, e.g., 2.29, a tag needs to be created. Do the following:
git checkout 2.29
git pull
yarn version (interactive, will ask you for a new version number, eg. 29.0.22)
git push origin master
git push origin v29.0.22 (pushes the v29.0.22 tag)
To deploy a major upgrade, it is necessary to branch the current version, and update the pom.xml on master. Details of this will be provided elsewhere.