Skip to content
This repository was archived by the owner on May 30, 2024. It is now read-only.

Commit 749b38c

Browse files
update image paths
1 parent 2dfa899 commit 749b38c

27 files changed

+26
-26
lines changed

SETUP.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ Instructions on how to setup, configure and deploy the backend service is as fol
1919
- Select **API keys** option on left pane of the dashboard.
2020
- Select **Create an IBM Cloud API key** button on right of the **API keys** dashboard.
2121
<p align="middle">
22-
<img src="images/backend/IAM/iamKey.PNG" width ="30%" height="30%">
22+
<img src="images/IAM/iamKey.PNG" width ="30%" height="30%">
2323
</p>
2424

2525
- Enter an API key name and description. Example,
2626
<p align="middle">
27-
<img src="images/backend/IAM/createIAMApikey.PNG" width ="30%" height="30%">
27+
<img src="images/IAM/createIAMApikey.PNG" width ="30%" height="30%">
2828
</p>
2929

3030
- An IAM API key will be created, copy and/or download the key and secure it safely.
@@ -35,22 +35,22 @@ Instructions on how to setup, configure and deploy the backend service is as fol
3535
- Click on **Manage** tab on top right of the IBM Cloud dashboard. And click on **Account** option to open **Account** dashboard.
3636
- Select **Resource groups** option on the left panel of the dashboard. Usually a **Default** resource group will be created when a cloud account is created. If not a new Resource group can be created by clicking on the **Create** button on the right of the **Resource groups** dashboard.
3737
<p align="middle">
38-
<img src="images/backend/account/resourceGrp.PNG" width ="30%" height="30%">
38+
<img src="images/account/resourceGrp.PNG" width ="30%" height="30%">
3939
</p>
4040

4141
- **Create Cloud Foundry Organization**;
4242

4343
- From the **Account** dashboard, select **Cloud Foundry orgs** option on the left pane to open **Cloud Foundry Orgs** dashboard.
4444
- Click on **Create** on the top right of the dashboard to create new Organization. If an organization already exists, you can use the same.
4545
<p align="middle">
46-
<img src="images/backend/account/organization.PNG" width ="30%" height="30%">
46+
<img src="images/account/organization.PNG" width ="30%" height="30%">
4747
</p>
4848

4949
- **Create Space**;
5050
- From the **Cloud Foundry Orgs** dashboard, click on the Name of the organization to open the **Space** tab for the organization.
5151
- Click on the **Add a space** button the top right of the dashboard to create new Space. If a space already exists, you can use the same.
5252
<p align="middle">
53-
<img src="images/backend/account/space.PNG" width ="30%" height="30%">
53+
<img src="images/account/space.PNG" width ="30%" height="30%">
5454
</p>
5555

5656
2. Git:
@@ -77,43 +77,43 @@ Follow the instructions to setup and configure IBM Cloud Functions.
7777
- Create a new IBM cloud account. If you already have an account, please log in to account.
7878
- Select **IBM Cloud Functions** icon on left the pane of the IBM Cloud account dashboard <br>
7979
<p align="middle">
80-
<img src="images/backend/cloudFunctions/dashboard_cloudFunctions.PNG" width ="30%" height="30%">
80+
<img src="images/cloudFunctions/dashboard_cloudFunctions.PNG" width ="30%" height="30%">
8181
</p>
8282

8383
&nbsp; &nbsp; &nbsp; &nbsp; Or you can search for **Functions** in search bar and select **Functions**.
8484

8585
<p align="middle">
86-
<img src="images/backend/cloudFunctions/searchCF.PNG" width ="30%" height="30%">
86+
<img src="images/cloudFunctions/searchCF.PNG" width ="30%" height="30%">
8787
</p>
8888

8989
- Select **Actions** option on the left pane of **IBM Cloud Functions** dashboard.
9090

9191
<p align="middle">
92-
<img src="images/backend/cloudFunctions/actionsCF.PNG" width ="30%" height="30%">
92+
<img src="images/cloudFunctions/actionsCF.PNG" width ="30%" height="30%">
9393
</p>
9494

9595
- Create new Actions by clicking the **Create** on top right of the dashboard, enter Action Name as **liquid-prep-action**. Create new Package **liquidPrep**. Select **Node.js 12** as Runtime.
9696

9797
<p align="middle">
98-
<img src="images/backend/cloudFunctions/createActionCF.PNG" width ="30%" height="30%">
98+
<img src="images/cloudFunctions/createActionCF.PNG" width ="30%" height="30%">
9999
</p>
100100

101101
- Go back to **IBM Cloud Functions** dashboard and select **APIs** option on the left pane.
102102

103103
<p align="middle">
104-
<img src="images/backend/cloudFunctions/api_cloudFunctions.PNG" width ="30%" height="30%">
104+
<img src="images/cloudFunctions/api_cloudFunctions.PNG" width ="30%" height="30%">
105105
</p>
106106

107107
- Select **Create API** option on top right of the dashboard, enter API name as **liquidPrep-cf-api**. Let the **Base path for API** be default **/liquidPrep-cf-api**. Let other settings be default values, unless other specific entries are required. Scroll down the page and select **Create**.
108108

109109
<p align="middle">
110-
<img src="images/backend/cloudFunctions/createAPI_CF.PNG" width ="30%" height="30%">
110+
<img src="images/cloudFunctions/createAPI_CF.PNG" width ="30%" height="30%">
111111
</p>
112112

113113
- Once API is created, select the API **liquidPrep-cf-api**, select **Manage Sharing and Keys** on the left pane of the API dashboard. Enable **Include API in organization-level Shared APIs view**.
114114

115115
<p align="middle">
116-
<img src="images/backend/cloudFunctions/shareAPI_CF.PNG" width ="30%" height="30%">
116+
<img src="images/cloudFunctions/shareAPI_CF.PNG" width ="30%" height="30%">
117117
</p>
118118

119119
## Setup IBM Cloudant
@@ -123,7 +123,7 @@ Follow the instructions to setup and configure IBM Cloudant.
123123
- Enter **Cloudant** in the IBM Cloud search bar and select **Cloudant**.
124124

125125
<p align="middle">
126-
<img src="images/backend/cloudant/searchCloudant.PNG" width ="30%" height="30%">
126+
<img src="images/cloudant/searchCloudant.PNG" width ="30%" height="30%">
127127
</p>
128128

129129
- Next configure the Cloudant DB,
@@ -135,19 +135,19 @@ Follow the instructions to setup and configure IBM Cloudant.
135135
- Select a suitable pricing Plan – Lite, Standard and Standard on Transaction Engine.
136136

137137
<p align="middle">
138-
<img src="images/backend/cloudant/configureCloudant.PNG" width ="30%" height="30%">
138+
<img src="images/cloudant/configureCloudant.PNG" width ="30%" height="30%">
139139
</p>
140140

141141
- Select **Create** on the bottom right pane of Cloudant dashboard. A message will be displayed to say that the instance is being provisioned, which returns you to the Resource list. From the Resource list, you see the status for your instance is, **Provision in progress.**
142142

143143
<p align="middle">
144-
<img src="images/backend/cloudant/activeCloudant.PNG" width ="30%" height="30%">
144+
<img src="images/cloudant/activeCloudant.PNG" width ="30%" height="30%">
145145
</p>
146146

147147
- When status of the instance changes to **Active**, click the **Cloudant-liquidPrep** instance and select **Service Credentials** tab on left pane of dashboard. Select **New Credential**, enter Name as **liquid-prep** and Role as **Manager**. A service credential will be created.
148148

149149
<p align="middle">
150-
<img src="images/backend/cloudant/serviceCredsCloudant.PNG" width ="30%" height="30%">
150+
<img src="images/cloudant/serviceCredsCloudant.PNG" width ="30%" height="30%">
151151
</p>
152152

153153
- Select **Manage** tab on the left pane and select **Launch Dashboard** on the top right of the page. It will launch a Cloudant dashboard to create new database.
@@ -156,27 +156,27 @@ Follow the instructions to setup and configure IBM Cloudant.
156156
- Enter Database name as **liquid-prep-crops**. Select the Partitioning option as **Non-partitioned**. And click on **Create** button at the bottom.
157157

158158
<p align="middle">
159-
<img src="images/backend/cloudant/createDBCloudant.PNG" width ="15%" height="30%">
159+
<img src="images/cloudant/createDBCloudant.PNG" width ="15%" height="30%">
160160
</p>
161161

162162
- The**liquid-prep-crops** database will be created and listed in Databases page.
163163

164164
- Select **liquid-prep-crops** and click on **Create Document** on top right of the page. A document with auto generated **\_id** key will open.
165165

166166
<p align="middle">
167-
<img src="images/backend/cloudant/createDoc_cloudant.PNG" width ="30%" height="30%">
167+
<img src="images/cloudant/createDoc_cloudant.PNG" width ="30%" height="30%">
168168
</p>
169169

170170
- Go to Liquid Prep project directory `~/LiquidPrep-Backend/backend/resources/crops`. Open each crop document, copy the contents in the document and paste it in the **New Document** that was opened in **liquid-prep-crops** database and click **Create Document** button.
171171

172172
- Example for Corn crop;
173173
<p align="middle">
174-
<img src="images/backend/cloudant/createDoc_cloudant_corn.PNG" width ="30%" height="30%">
174+
<img src="images/cloudant/createDoc_cloudant_corn.PNG" width ="30%" height="30%">
175175
</p>
176176

177177
- Corn document will be created and listed in **liquid-prep-crops** database.
178178
<p align="middle">
179-
<img src="images/backend/cloudant/liquidPrep_cloudant_cropsList.PNG" width ="30%" height="30%">
179+
<img src="images/cloudant/liquidPrep_cloudant_cropsList.PNG" width ="30%" height="30%">
180180
</p>
181181

182182
- Similarly, repeat previous step for all the other crops document.
@@ -206,13 +206,13 @@ After seeting up and configuring IBM Cloud Functions and Cloudant DB, the Liquid
206206
- Select **API Management** option.
207207
208208
<p align="middle">
209-
<img src="images/backend/envEntries/apiManage.PNG" width ="30%" height="30%">
209+
<img src="images/envEntries/apiManage.PNG" width ="30%" height="30%">
210210
</p>
211211
212212
- Select **Shared APIs** in **API Management** dashboard.
213213
- The **Route** value in **Shared APIs** dashboard is the **CLOUD_FUNCTIONS_URL** value.
214214
<p align="middle">
215-
<img src="images/backend/envEntries/sharedApi.PNG" width ="30%" height="30%">
215+
<img src="images/envEntries/sharedApi.PNG" width ="30%" height="30%">
216216
</p>
217217
218218
- **_CLOUDANT_DB_NAME: liquid-prep-crops_** <br>
@@ -227,12 +227,12 @@ After seeting up and configuring IBM Cloud Functions and Cloudant DB, the Liquid
227227
- Select **Cloudant-liquidPrep** instance under **Services** in **Resource list** dashboard.
228228
229229
<p align="middle">
230-
<img src="images/backend/envEntries/cloudantService.PNG" width ="30%" height="30%">
230+
<img src="images/envEntries/cloudantService.PNG" width ="30%" height="30%">
231231
</p>
232232
233233
- The **External Endpoint (preferred)** value is the **CLOUDANT_DB_URL** value.
234234
<p align="middle">
235-
<img src="images/backend/envEntries/cloudantEndpoint.PNG" width ="30%" height="30%">
235+
<img src="images/envEntries/cloudantEndpoint.PNG" width ="30%" height="30%">
236236
</p>
237237
238238
- **_WEATHER_API_KEY:_** <br>
@@ -261,13 +261,13 @@ After seeting up and configuring IBM Cloud Functions and Cloudant DB, the Liquid
261261
- **-r**: <br>
262262
It is the **Region** of the cloud account. Region can be obtained in the selected **Cloud Foundry Organization** dashboard beside the **Space** Name.
263263
<p align="middle">
264-
<img src="images/backend/account/space.PNG" width ="30%" height="30%">
264+
<img src="images/account/space.PNG" width ="30%" height="30%">
265265
</p>
266266

267267
- Navigate to project directory `~/LiquidPrep-Backend/backend/liquid-prep-cf` from command terminal and execute `npm run deploy-dev-api`.
268268

269269
- Once the deployment is successful, go to IBM Cloud Functions dashboard, select **Actions** tab on the left pane and you can see **liquid-prep-action** instance in the **Actions** dashboard.
270270

271271
<p align="middle">
272-
<img src="images/backend/cloudFunctions/liquidPrep-Actions-CF.PNG" width ="30%" height="30%">
272+
<img src="images/cloudFunctions/liquidPrep-Actions-CF.PNG" width ="30%" height="30%">
273273
</p>
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)