This app requires Auth0 to provides Single sign-on (SSO) that allow users to log in with single ID and password such as Gmail or other variety of available providers, and a diverse set of user-friendly tools the developer will really like.
https://your_domain.com, http://localhost:3000
https://your_domain.com, https://your_domain.com/login, http://localhost:3000
Environment Setup:
export WAI_AUTH0_DOMAIN="string_url"
export WAI_AUTH0_CLIENT_ID="string"
export WAI_AUTH0_SECRET="string"
export WAI_AUTH0_AUDIENCE="string"
export WAI_AUTH0_SECRET="string"
export WAI_AUTH0_SPA_DOMAIN="string_url"
export WAI_AUTH0_SPA_CLIENT_ID="string"
export INSTANCE_NAME="wai-demo"
Note: WAI_AUTH0_AUDIENCE
is comming from Grant ID (API's tab) in your Auth0 Machine to Machine applications
When running the test, any upload and download activities will not uploaded directly as Storage object (offered by Google Cloud). It stored inside ./backend/tmp/fake-storage
Environment Setup:
export GOOGLE_APPLICATION_CREDENTIALS=path_to_service_account.json
If you want to use custom storage location (e.g storage in local backend container). add STORAGE_LOCATION
to the backend environment. Example format: "/tmp/storage".
export STORAGE_LOCATION=/tmp/storage
To use the Mailjet Email API, you need to create a Mailjet account, then retrieve your API and Secret keys. They will be used for authentication purposes.
export MAILJET_SECRET="string"
export MAILJET_APIKEY="string"
Now you have all the required environment ready, then run the App using:
export INSTANCE_NAME=<project-name>
docker compose up -d
To stop:
docker compose down
Reset the app:
docker compose down -v
The app should be running at: localhost:3000. Any endpoints with prefix
/api
is redirected to localhost:5000/worker
is for worker service in localhost:5001/config.js
is a static config that redirected to localhost:5001/config.jssee: setupProxy.js
Before you seed the baseline data, please make sure that you have all the required file in the following structure:
Folder Path: /backend/source/
/backend/source.
└── project-name
├── config.js
├── config.min.js
├── data
│ └── organisation.csv
├── forms
│ ├── 01-clts.json
│ ├── 02-health.json
│ ├── 03-hh.json
│ ├── 04-school.json
│ └── 05-wp.json
└── topojson.js
Note that project-name should be same as INSTANCE_NAME that you exported
Assuming that you have topojson.js inside ./backend/source/{project_name}
folder you will be able to run.
docker compose exec backend python -m seeder.administration
To seed organisation, you need to have organisation.csv inside ./backend/source/{project_name}/data
folder you will be able to run.
docker compose exec backend python -m seeder.organisation
Note you wont be able to use some of the backend API if you haven't confirmed your email address with Auth0 tenant which you will received once your account is registered. You also have to perform Administration and Organisation Seeder first
docker compose exec backend python -m seeder.admin youremail@akvo.org "Your Name" Akvo
docker compose exec backend python -m seeder.user <number_of_user> Akvo
This command allows you to add new users to the portal with ease without providing parameters like before.
docker compose exec backend python -m seeder.user
Once the command is executed, then you will be asked to input these required fields.
Field | Type | Description |
---|---|---|
Full Name | String | User's full name |
Email Address | String | User's email |
Organisation Name | String | User's organisation name |
Role [admin, editor] | enum: admin , editor |
Set user's role |
Assuming that you have id-form_name.json inside ./backend/source/{project_name}/forms/
folder you should be able to run.
docker compose exec backend python -m seeder.form
You can also run the command above to updating the form.
Note: Once you update the form then the version of the form will be automatically updated.
Or, you need to truncate the existing form and replace it with a new one then the command to be executed becomes
docker compose exec backend python -m seeder.form --truncate
Assuming that you have baseline.xlsx inside ./backend/source
folder you should be able to run.
docker compose exec backend python -m seeder.datapoint youremail@akvo.org
If you wish to run all the necessary seeder, you could also run
docker compose exec backend ./seed.sh youremail@akvo.org "Your Name" Akvo
docker compose exec backend ./test.sh
JMP Logic implementation has been done by the AkvoResponseGrouper library and we just need to create a category.json inside the source folder and place it in a specific instance.
For example, if we want to implement JMP logic on the Ethiopia instance, then category.json should be created on
/backend/source/wai-ethiopia/category.json
This section contains the properties that will be used in configuring the JMP logic in category.json.
Criteria's fields | Field | Type | Description |
---|---|---|---|
name | String | Criteria name | |
form | Integer | Existing form ID in database | |
categories | Array of category | List of categories |
Category's fields | Field | Type | Description |
---|---|---|---|
name | String | Category name | |
questions | Array of question including the logic | List of existing questions and their logic |
Questions & logic's fields | Field | Type | Required | Description |
---|---|---|---|---|
id | Integer | Yes | Existing question ID in database | |
text | String | No | Question description | |
options | Array of string | Yes | Set list of options that will have intersections with the answer to the question | |
other | Array of other | No | Another set of lists of options that don't have intersections in the options |
|
else | Object | No | Set category that has no intersections, either in options or other |
Other's fields | Field | Type | Required | Description |
---|---|---|---|---|
name | String | Yes | Category name | |
options | Array of string | Yes | Set list of options that will have intersections with the answer to the question | |
questions | Array of question | Yes | List of existing questions and their logic and can be set empty of Array [] |
Else's fields | Field | Type | Required | Description |
---|---|---|---|---|
name | String | No | Category name | |
ignore | Array of existing question IDs | No | Set list of question IDs that can be skipped based on the intersections in the options |
To get an example of category.json you can find it in one of the instances, like the one in Ethiopia here:
./backend/source/wai-ethiopia/category.json
This section contains ways to run or apply JMP logic from category.json to the portal/database system.
~$ akvo-responsegrouper --config {{category.json}}
Assuming we will run the JMP logic in Ethiopia, then the command will be as follows
docker compose exec backend akvo-responsegrouper --config ./source/wai-ethiopia/category.json
Please read the full documentation here: https://wai-sdg-portal.readthedocs.io/en/latest
For further information about the file formats please contact tech.consultancy@akvo.org