diff --git a/README.md b/README.md index 7f028fe..1d787ff 100644 --- a/README.md +++ b/README.md @@ -55,17 +55,22 @@ Surrounding files are there to get data into source files (such as users.json or Make sure to use Jakub's `dhis_env` script or manually set environment variables to fill in credentials for the server. See `testData/api.py` for more details. ## Deploying +If you are deploying to your own server you can run `npm run-scripts build` and upload the resulting zip file to your DHIS2 instance. + +For a production release there are a few more steps: 1. Make sure tests are passing -2. Update packages.json to increment version number -3. Create Zip `npm run-scripts build` -4. Tag the release in github and upload Zip +2. Update `packages.json` to increment version number +3. Create the zip file: `npm run-scripts build` +4. Tag the release in github and upload the zip file 5. Make deploy script utilizing `src/lib/libAppRepairs.sh` - #!/usr/bin/env bash - source ../../src/lib/libAppRepairs.sh - APPROVAL_APP_VERSION="x.y.z" - printInfo 'Deleting the old Approvals App' - deleteOldVersion "Data-Approval" - installApp "Data-Approval" $APPROVAL_APP_VERSION - exit 0 +```sh +#!/usr/bin/env bash +source ../../src/lib/libAppRepairs.sh +APPROVAL_APP_VERSION="x.y.z" +printInfo 'Deleting the old Approvals App' +deleteOldVersion "Data-Approval" +installApp "Data-Approval" $APPROVAL_APP_VERSION +exit 0 +```