Skip to content

Change ReadMe Format #8

@surabhi-mahawar

Description

@surabhi-mahawar

Change the Docker Readme according to below format.

Docker Deploy Readme format

- Introduction - docker-deploy as the name suggests is a docker-based deployment script that can be used to set up the UCI for usage.

- Intended users of this repo - All the adopters of UCI who want to set up an instance of UCI for usage

- Pre-requisites for setting up UCI
    - Infra - 
    - Engineering skill - 

- Common Errors and resolution
    - Error 1
    - Error 2
    - In case of any error, feel free to reach out to the community at the link here:

- After a successful setup completion -
    - Script execution time - 
    - On a successful run of the script you will get - 
        - Item 1 - 
        - Item 2 - 
        - Item 3 - 

Now that we are ready with the basic setup, lets see what it will take to get your first bot ready for communication.

Steps after docker setup:

1. For inbound API calls from the service provider - Get your IP whitelisted
2. For outbound API calls get tokens from the Service provider
3. Track tables on Hasura to make graph queries
4. Adding default transformers in your setup (Can't this be automated?)

Setting up your first bot
1. API call to Upload ODK form (Add sample ODK form)
2. API call to Create a conversation logic (API doc reference)
3. API call to Create a bot (API doc reference)

Update Form list of transformer? _<Question>Why is it needed?_

Start using bot
1. DO Step 1
2. Do Step 2
3. Do step 3

Using FusionAuth to manage user segment
1. Console URL: 
2. Action 1: 
3. Action 2:

Manage assessment data (What is this?)
1. 
2.
3.

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions