-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'feature-ncd' into feature-ncda
- Loading branch information
Showing
29 changed files
with
134 additions
and
532 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -24,52 +24,86 @@ Primary ports: | |
|
||
### GitPod first steps | ||
1. Wait until the Drupal login page shows up | ||
2. Login with `admin` / `admin` into the Drupal backend. | ||
3. Choose "Remote Explorer" on the left and open port 3000 too, either in new browser window or in preview. | ||
4. Use `12345678` as the pairing code (tied to Device nodes at the Drupal side). | ||
5. Use `1234` as the PIN code (tied to the Nurse nodes at the Drupal side). | ||
6. Initiate a sync process. The device status page allows you to initiate a manual sync with the backend. | ||
1. Login with `admin` / `admin` into the Drupal backend. | ||
1. Choose "Remote Explorer" on the left and open port 3000 too, either in new browser window or in preview. | ||
1. Use `12345678` as the pairing code (tied to Device nodes at the Drupal side). | ||
1. Use `1234` as the PIN code (tied to the Nurse nodes at the Drupal side). | ||
1. Initiate a sync process. The device status page allows you to initiate a manual sync with the backend. | ||
You can also choose which health centers to sync, for instance "Nyange Health Center" for the tests. | ||
7. Choose the synced health center. | ||
8. Explore the system. | ||
1. Choose the synced health center. | ||
1. Explore the system. | ||
|
||
## Develop locally with DDEV | ||
## Try out locally with DDEV | ||
|
||
### Requirements | ||
1. https://ddev.readthedocs.io/en/latest/#installation . Minimum version: [v1.21.1](https://github.com/drud/ddev/releases/tag/v1.21.1) | ||
1. cp .ddev/config.local.yaml.example .ddev/config.local.yaml | ||
1. ddev restart | ||
1. `cp client/src/elm/LocalConfig.Example.elm client/src/elm/LocalConfig.elm` | ||
1. `ddev gulp` | ||
1. Open the [app](http://localhost:3000) in the browser, typically it listens on port 3000. | ||
1. Use `12345678` as the pairing code (tied to Device nodes at the Drupal side). | ||
1. Use `1234` as the PIN code (tied to the Nurse nodes at the Drupal side). | ||
1. Initiate a sync process. The device status page allows you to initiate a manual sync with the backend. | ||
You can also choose which health centers to sync, for instance "Nyange Health Center" for the tests. | ||
1. Choose the synced health center. | ||
1. Explore the system. | ||
|
||
- https://ddev.readthedocs.io/en/latest/#installation . Minimum version: [v1.21.1](https://github.com/drud/ddev/releases/tag/v1.21.1) | ||
### Frontend | ||
|
||
### Backend | ||
#### Prerequisites | ||
|
||
Make sure the following is installed: | ||
|
||
1. Elm Format (`npm install -g [email protected]`), not strictly required for the development, but the standard must be followed, as Travis checks that. Therefore it's highly suggested to run Elm Format upon save at your IDE (https://github.com/avh4/elm-format#editor-integration). | ||
|
||
#### Installation | ||
|
||
cp .ddev/config.local.yaml.example .ddev/config.local.yaml | ||
ddev restart | ||
* Install backend first. | ||
* `cp src/elm/LocalConfig.Example.elm src/elm/LocalConfig.elm` | ||
|
||
You may need to update `src/elm/LocalConfig.elm` if your local URLs are different from the default setting. | ||
|
||
#### Usage | ||
|
||
1. Serve locally, and watch file changes: `ddev gulp` | ||
2. Prepare file for publishing (e.g. minify, and rev file names): `ddev gulp publish` | ||
3. Deploy to GitHub's pages (`gh-pages` branch of your repository): `ddev gulp deploy` | ||
|
||
#### Getting started | ||
|
||
Frontend: http://localhost:3000 (that comes from inside DDEV after `ddev gulp`) | ||
|
||
The Drupal migration creates Devices, Nurses out of the box, so you can | ||
1. Use `12345678` as the pairing code (tied to Device nodes at the Drupal side). | ||
1. Use `1234` as the PIN code (tied to the Nurse nodes at the Drupal side). | ||
|
||
Migrate content with either `ddev migrate default` or `ddev migrate sample` | ||
depending on whether you want minimal development content or a full set of | ||
sample content (takes much longer). | ||
If you have a dump from another source, to be able to work locally, first of all, you need to create a Device and a Nurse. | ||
1. `ddev drush uli` to login as `admin` | ||
1. Fulfill https://eheza-app.ddev.site:4443/node/add/device , note the Pairing code. | ||
1. Fulfill https://eheza-app.ddev.site:4443/node/add/nurse , note the PIN code, assign it to group(s) and health center(s). | ||
1. Visit http://localhost:3000 (that comes from inside DDEV), supply the Pairing code and the PIN. | ||
|
||
#### Z-Scores | ||
|
||
The installation script will perform following steps: | ||
Our `gulpfile.js` has a task `ddev gulp zscore` which converts the raw Z-Score tables we | ||
downloaded from the WHO web site into three formats: | ||
|
||
1. Delete the /www folder. | ||
2. Recreate the /www folder. | ||
3. Download and extract all contrib modules, themes & libraries to the proper | ||
subfolders of the profile. | ||
4. Download and extract Drupal 7 core in the /www folder | ||
5. Create an empty sites/default/files directory | ||
6. Makes a symlink within the /www/profiles directory to the /hedley | ||
directory. | ||
7. Run the Drupal installer (Drush) using the Hedley profile. | ||
- A JSON representation the client can download via an HTTP request (and | ||
cache). | ||
- A JSON representation that the backend can load (to calculate Z-Scores on the | ||
backend. | ||
- An Elm module which contains the JSON representation as a string, so we can | ||
unit-test the Elm code. | ||
|
||
***Warning!*** | ||
This should all happen automatically when you run `ddev gulp`. | ||
|
||
* The process above will not preserve the data located in the | ||
sites/default/files directory. | ||
* The database is dropped during the installation. | ||
#### Develop how-to | ||
|
||
After you edited an Elm file, and the compilation process is executed, the changes are not visible in the browser. | ||
To activate the new version you've just created, click on the "Version" indication in the top-right corner of the app. | ||
That will take you to a page which allows you to check for updates and activate updates. | ||
|
||
#### Deploy | ||
#### Deployment | ||
|
||
The default method assumes Pantheon as the hosting service provider. | ||
|
||
|
@@ -127,57 +161,3 @@ If that's a no-go, for the advancedqueue, `supervisord` is a better choice, | |
as that queue needs to be processed all the time. For the reporting, a simple | ||
cron job might be sufficient. | ||
|
||
### Frontend | ||
|
||
#### Prerequisites | ||
|
||
Make sure the following is installed: | ||
|
||
1. Elm Format (`npm install -g [email protected]`), not strictly required for the development, but the standard must be followed, as Travis checks that. Therefore it's highly suggested to run Elm Format upon save at your IDE (https://github.com/avh4/elm-format#editor-integration). | ||
|
||
#### Installation | ||
|
||
* Install backend first. | ||
* `cp src/elm/LocalConfig.Example.elm src/elm/LocalConfig.elm` | ||
|
||
You may need to update `src/elm/LocalConfig.elm` if your local URLs are different from the default setting. | ||
|
||
#### Usage | ||
|
||
1. Serve locally, and watch file changes: `ddev gulp` | ||
2. Prepare file for publishing (e.g. minify, and rev file names): `ddev gulp publish` | ||
3. Deploy to GitHub's pages (`gh-pages` branch of your repository): `ddev gulp deploy` | ||
|
||
#### Getting started | ||
|
||
Frontend: http://localhost:3000 (that comes from inside DDEV after `ddev gulp`) | ||
|
||
The Drupal migration creates Devices, Nurses out of the box, so you can | ||
1. Use `12345678` as the pairing code (tied to Device nodes at the Drupal side). | ||
1. Use `1234` as the PIN code (tied to the Nurse nodes at the Drupal side). | ||
|
||
If you have a dump from another source, to be able to work locally, first of all, you need to create a Device and a Nurse. | ||
1. `ddev drush uli` to login as `admin` | ||
1. Fulfill https://eheza-app.ddev.site:4443/node/add/device , note the Pairing code. | ||
1. Fulfill https://eheza-app.ddev.site:4443/node/add/nurse , note the PIN code, assign it to group(s) and health center(s). | ||
1. Visit http://localhost:3000 (that comes from inside DDEV), supply the Pairing code and the PIN. | ||
|
||
#### Z-Scores | ||
|
||
Our `gulpfile.js` has a task `ddev gulp zscore` which converts the raw Z-Score tables we | ||
downloaded from the WHO web site into three formats: | ||
|
||
- A JSON representation the client can download via an HTTP request (and | ||
cache). | ||
- A JSON representation that the backend can load (to calculate Z-Scores on the | ||
backend. | ||
- An Elm module which contains the JSON representation as a string, so we can | ||
unit-test the Elm code. | ||
|
||
This should all happen automatically when you run `ddev gulp`. | ||
|
||
#### Develop how-to | ||
|
||
After you edited an Elm file, and the compilation process is executed, the changes are not visible in the browser. | ||
To activate the new version you've just created, click on the "Version" indication in the top-right corner of the app. | ||
That will take you to a page which allows you to check for updates and activate updates. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.