https://github.com/dhis2/app-runtime
A singular runtime dependency for applications on the DHIS2 platform
https://github.com/dhis2/app-runtime
synced-settings web-lib
Last synced: 4 months ago
JSON representation
A singular runtime dependency for applications on the DHIS2 platform
- Host: GitHub
- URL: https://github.com/dhis2/app-runtime
- Owner: dhis2
- Created: 2019-03-20T12:36:02.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-11T11:37:23.000Z (over 1 year ago)
- Last Synced: 2024-10-14T08:02:14.575Z (over 1 year ago)
- Topics: synced-settings, web-lib
- Language: TypeScript
- Homepage: https://runtime.dhis2.nu
- Size: 6.49 MB
- Stars: 15
- Watchers: 28
- Forks: 13
- Open Issues: 59
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# DHIS2 Application Runtime
[](https://www.npmjs.com/package/@dhis2/app-runtime)
[](https://github.com/semantic-release/semantic-release)
Docs are available at [developers.dhis2.org](https://developers.dhis2.org/docs/app-runtime/).
## Development
```sh
yarn test # runs yarn test on each directory under ./services, and also in ./runtime
yarn build # runs yarn build on each directory under ./services, and then in ./runtime
yarn start # builds all services, builds the runtime, and starts the query playground server
```
## Examples
A `create-react-app` example is available at [./examples/cra](./examples/cra). If running `yarn install` locally in the example directory, be sure to run it with `yarn install --force --check-files` so that it pulls in the runtime (specified as a `file:` dependency).
A query REPL platform application is also available at `./examples/query-playground`.
Running `yarn build` at root will automatically update the example app's copy, and running `yarn start` will build the runtime and then start the example.
A [`DHIS2 App Platform`](https://developers.dhis2.org/docs/app-platform/getting-started) example is available at [./examples/query-playground](./examples/query-playground). This is a full, deployable DHIS2 application and a live standalone version is available at [every play instance](https://play.dhis2.org).
## Release
Releases run automatically for every commit to the master branch using the [d2 cli](https://github.com/dhis2/cli).
**NEVER PUSH DIRECTLY TO `master`! ALL DEVELOPMENT IN THIS REPOSITORY IS THROUGH PULL REQUESTS**
## Report an issue
The issue tracker can be found in [DHIS2 JIRA](https://jira.dhis2.org)
under the [LIBS](https://jira.dhis2.org/projects/LIBS) project.
Deep links:
- [Bug](https://jira.dhis2.org/secure/CreateIssueDetails!init.jspa?pid=10700&issuetype=10006&components=11024)
- [Feature](https://jira.dhis2.org/secure/CreateIssueDetails!init.jspa?pid=10700&issuetype=10300&components=11024)
- [Task](https://jira.dhis2.org/secure/CreateIssueDetails!init.jspa?pid=10700&issuetype=10003&components=11024)