Skip to content
HIV Indicators Tool for district level estimates of HIV epidemic indicators
TypeScript Kotlin Vue Java CSS JavaScript Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docker
scripts
src
.gitignore
.travis.yml
Dockerfile
README.md
codecov.yml
package-lock.json

README.md

HINT - HIV Indicators Tool

Build Status codecov

SpringBoot Kotlin web app for interfacing with the Naomi model for joint small-area estimation of HIV prevalence, ART coverage, and HIV incidence via the hintr package

Developing

Requirements:

  • Docker
  • npm
  • openjdk 8
  1. Clone this repo
  2. Run npm install from src/app/static
  3. Run ./scripts/run-development-dependencies.sh to start docker instances of hint-db and hintr and add a test user with username test.user@example.com and password password.
  4. Run npm run build from src/app/static to compile front-end dependencies.
  5. Run app from your IDE or by cd src && ./gradlew :app:bootRun to serve the app on port 8080

For more information about developing the front-end see src/app/static/README

Testing

Ensure dependencies are running and then execute tests on the command line or through IntelliJ

  1. ./scripts/run-development-dependencies.sh
  2. ./src/gradlew -p src app::test

Database Interface

If the database schema has changed, you can regenerate the database interface code (in /src/databaseInterface) by running ./src/gradlew -p src :generateDatabaseInterface:run while the database container is running.

Distribution

A docker image containing the app is created by running ./scripts/build-app.sh. This is run as part of the Travis build. Run docker run -p 8080:8080 mrcide/hint:branch_name to run a built image.

You can’t perform that action at this time.