D2FSAM

DHIS2 API + Field Short-lived Activity Management. DHIS2 API + some functionalities for managing field short-lived activities that we need to be part of the core to meet some of our requirements, after the activity is completed and its data is reviewed, the data gets synchronized to a DHIS2 instance used as the core system for warehousing the core data. The main reason it was created for started to replace some tasks that is hard to manage by KOBO|ODK, or other general data collection tools based on our requirements.

It was first only our simple system used to coordinate KOBO|ODK and other tools with the DHIS2 instance, after that we merged DHIS2 API to utilize its dynamic core and design to it in stages, now most of DHIS2 api is merged to it.

A Mobile App was also developed to connect to these functionalities.

Main Functionalities provided:

Activities and tasks management.
Teams Management.
Assignments management: Creating plan and assign teams to it prior to the activity and in the field, field supervisors create users on the fly and connect each user with the team planned, and when the user sign in all his assignments gets synced to his mobile.
Managing Review Process.
A Profile for each user is kept on the system storing his info, his history of work, his achievements and scores, so it's easier in next activities to choose users that suits each task.
- A profile for each activity storing its detailed info, and the final report, and any documents related to the activity.

Future Functionalities:

Management of Shor-lived Warehouses, managing field warehouse that is setup on the fly for each activity.
Other.

Project Structure

Node is required for generation and recommended for development. package.json is always generated for a better development experience with prettier, commit hooks, scripts and so on.

In the project root, D2FSAM generates configuration files for tools like git, prettier, eslint, husky, and others that are well known and you can find references in the web.

/src/* structure follows default Java structure.

.yo-rc.json - Yeoman configuration file D2FSAM configuration is stored in this file at generator-d2fsam key. You may find generator-d2fsam-* for specific blueprints configuration.
.yo-resolve (optional) - Yeoman conflict resolver Allows to use a specific action when conflicts are found skipping prompts for files that matches a pattern. Each line should match [pattern] [action] with pattern been a Minimatch pattern and action been one of skip (default if ommited) or force. Lines starting with # are considered comments and are ignored.
npmw - wrapper to use locally installed npm. D2FSAM installs Node and npm locally using the build tool by default. This wrapper makes sure npm is installed locally and uses it avoiding some differences different versions can cause. By using ./npmw instead of the traditional npm you can configure a Node-less environment to develop or test your application.
/docker - Docker configurations for the application and services that the application depends on

Development

Before you can build this project, you must install and configure the following dependencies on your machine:

Node.js: We use Node to run a development web server and build the project. Depending on your system, you can install Node either from source or as a pre-packaged bundle.

After installing Node, you should be able to run the following command to install development tools. You will only need to run this command when dependencies change in package.json.

npm install

We use npm scripts and Angular CLI with Webpack as our build system.

Run the following commands in two separate terminals to create a blissful development experience where your browser auto-refreshes when files change on your hard drive.

./mvn
npm start

Npm is also used to manage CSS and JavaScript dependencies used in this application. You can upgrade dependencies by specifying a newer version in package.json. You can also run npm update and npm install to manage dependencies. Add the help flag on any command to see how you can use it. For example, npm help update.

The npm run command will list all of the scripts available to run for this project.

PWA Support

D2FSAM ships with PWA (Progressive Web App) support, and it's turned off by default. One of the main components of a PWA is a service worker.

The service worker initialization code is disabled by default. To enable it, uncomment the following code in webapp/app/app.module.ts:

ServiceWorkerModule.register('ngsw-worker.js', { enabled: false }),

Managing dependencies

For example, to add Leaflet library as a runtime dependency of your application, you would run following command:

npm install --save --save-exact leaflet

To benefit from TypeScript type definitions from DefinitelyTyped repository in development, you would run following command:

npm install --save-dev --save-exact @types/leaflet

Then you would import the JS and CSS files specified in library's installation instructions so that Webpack knows about them: Edit d2fsam-web-app/webapp/app/app.module.ts file:

import 'leaflet/dist/leaflet.js';

Edit d2fsam-web-app/webapp/content/scss/vendor.scss file:

@import '~leaflet/dist/leaflet.css';

Note: There are still a few other things remaining to do for Leaflet that we won't detail here.

For further instructions on how to develop with D2FSAM, have a look at [Using D2FSAM in development][].

Using Angular CLI

You can also use Angular CLI to generate some custom client code.

For example, the following command:

ng generate component my-component

will generate few files:

create d2fsam-web-app/webapp/app/my-component/my-component.component.html
create d2fsam-web-app/webapp/app/my-component/my-component.component.ts
update d2fsam-web-app/webapp/app/app.module.ts

Building for production

Packaging as jar

To build the final jar and optimize the amSystemBack application for production, run:

./mvn -Pprod clean verify

This will concatenate and minify the client CSS and JavaScript files. It will also modify index.html so it references these new files. To ensure everything worked, run:

java -jar target/*.jar

Then navigate to http://localhost:8080 in your browser.

Refer to [Using D2FSAM in production][] for more details.

Packaging as war

To package your application as a war in order to deploy it to an application server, run:

./mvn -Pprod,war clean verify

Testing

To launch your application's tests, run:

./mvn verify

Client tests

Unit tests are run by Jest. They're located in src/test/javascript/ and can be run with:

npm test

For more information, refer to the [Running tests page][].

Code quality

Sonar is used to analyse code quality. You can start a local Sonar server (accessible on http://localhost:9001) with:

docker-compose -f docker/sonar.yml up -d

Note: we have turned off authentication in docker/sonar.yml for out of the box experience while trying out SonarQube, for real use cases turn it back on.

You can run a Sonar analysis with using the sonar-scanner or by using the maven plugin.

Then, run a Sonar analysis:

./mvn -Pprod clean verify sonar:sonar

If you need to re-run the Sonar phase, please be sure to specify at least the initialize phase since Sonar properties are loaded from the sonar-project.properties file.

./mvn initialize sonar:sonar

For more information, refer to the [Code quality page][].

Using Docker to simplify development (optional)

You can use Docker to improve your D2FSAM development experience. A number of docker-compose configuration are available in the docker folder to launch required third party services.

For example, to start a postgresql database in a docker container, run:

docker-compose -f docker/postgresql.yml up -d

To stop it and remove the container, run:

docker-compose -f docker/postgresql.yml down

You can also fully dockerize your application and all the services that it depends on. To achieve this, first build a docker image of your app by running:

npm run java:docker

Or build a arm64 docker image when using an arm64 processor os like MacOS with M1 processor family running:

npm run java:docker:arm64

Then run:

docker-compose -f docker/app.yml up -d

When running Docker Desktop on MacOS Big Sur or later, consider enabling experimental Use the new Virtualization framework for better processing performance (disk access performance is worse).

For more information refer to [Using Docker and Docker-Compose][], this page also contains information on the docker-compose sub-generator (d2fsam docker-compose), which is able to generate docker configurations for one or several D2FSAM applications.

Continuous Integration (optional)

To configure CI for your project, run the ci-cd sub-generator (d2fsam ci-cd), this will let you generate configuration files for a number of Continuous Integration systems. Consult the [Setting up Continuous Integration][] page for more information.

Hamza-ye / d2fsam