Install AWS CLI: https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html
- Add HEALEE_STAGE_URL and HEALEE_STAGE_AUTH (provided by the Healee team) to the end of your ~/.bashrc / ~/.zshrc / etc. file.
E.g.
export HEALEE_STAGE_URL=<your_healee_stage_url>
export HEALEE_STAGE_AUTH=<your_healee_stage_auth_token>
- Add the provided named AWS profile to your ~/.aws/credentials file.
You can read more about named AWS profiles here: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html
-
Clone this repository.
-
Run:
./protocol.sh fetch <protocol name>to fetch the initial version of the protocol. -
The protocol will be downloaded to the ./development/<protocol name> folder.
-
After making changes to the files, run
./protocol.sh build <protocol name>to build and deploy the changed version of the protocol.
-
Login / Register in the provided Healee staging environment.
-
Go to section Profile and click the button Add Protocol.
-
Select your protocol and install it.
-
The protocol is added to your profile. Click its name to open it.
-
If you would like to test the providers widget (showing the list of providers associated with this protocol), create one or several accounts in the staging environment for providers (e.g. Healee MD) and ask the Healee team to link these providers with the protocol you are working on.
When you want to test reminders for notifications which you've added to the protocol, you can use the protocol.sh tool to speed up the process because sometimes even if you've put "Minutes" for the period attribute, you may need to wait some extra minutes for the scheduler job to run.
e.g.
./protocol.sh notify <protocol name>
The storage for the protocol files does not support versioning and that's why we recommend adding the protocol files to your own private / public repository right after the initial fetch of the protocol files.
e.g.
./protocol.sh fetch <protocol name>
cd development/<protocol name>
git init
git remote add origin <your git repo url>
...