https://github.com/mrc-ide/mint

Malaria Indicators Tool
https://github.com/mrc-ide/mint

Last synced: about 2 months ago
JSON representation

Malaria Indicators Tool

• Host: GitHub
• URL: https://github.com/mrc-ide/mint
• Owner: mrc-ide
• License: mit
• Created: 2020-03-25T16:16:37.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-08T09:21:11.000Z (9 months ago)
• Last Synced: 2024-04-08T10:31:37.458Z (9 months ago)
• Language: TypeScript
• Size: 6.46 MB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.MD

Awesome Lists containing this project

README

        
## MINT - Malaria Indicators Tool

[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)

[![Build status](https://badge.buildkite.com/66f7223c769be9e00f87608c6c1485e222fa2f157284db3cfc.svg)](https://buildkite.com/mrc-ide/mint)

[![codecov](https://codecov.io/gh/mrc-ide/mint/branch/master/graph/badge.svg)](https://codecov.io/gh/mrc-ide/mint)

To make use of a built docker image:

```

docker run --rm -p 8080:8080 mrcide/mint

```

 

### Developing

Requirements:

* Docker

* NodeJS 20 with npm

* openjdk 21

* coreutils or realpath (Mac users only)

1. Clone this repo

1. Run `npm install` from `src/app/static`

1. Run `npm run build` from `src/app/static` to compile front-end dependencies.

1. Run `./scripts/run-development-dependencies.sh` to start docker instances of [mintr](https://github.com/mrc-ide/mintr)

1. 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](https://github.com/mrc-ide/mint/blob/master/src/app/static/README.md)

### Back-end Testing

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

1. `./scripts/run-development-dependencies.sh`

1. `./src/gradlew -p src app:test`

### Front-end Testing

1. To run unit tests, run `npm test` from `src/app/static`

2. To run integration tests, run `./scripts/run-dependencies` then `npm run integration-test`, both from `src/app/static`

### Distribution

A docker image containing the app is created as part of the BuildKite build and the resulting image pushed to Dockerhub. 

To run a built image:

```

docker run -p 8080:8080 mrcide/mint:branch_name

```

or

```

docker run -p 8080:8080 mrcide/mint:git_sha

```