diff --git a/README.md b/README.md index c859957..d083eae 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ N/A ## Credits -This application was architected and developed by David Mwita and Arshia Moghimi. Thanks to the UBC Cloud Innovation Centre Technical and Project Management teams for their guidance and support. +This application was architected and developed by [David Mwita](https://www.linkedin.com/in/davidmwita/) and [Arshia Moghimi](https://www.linkedin.com/in/arshia-moghimi-3a7a41150/). Thanks to the UBC Cloud Innovation Centre Technical and Project Management teams for their guidance and support. This was based on work from [ServerlessPDFChat](https://github.com/aws-samples/serverless-pdf-chat). diff --git a/docs/deploymentGuide.md b/docs/deploymentGuide.md index ddb74c7..40cc497 100644 --- a/docs/deploymentGuide.md +++ b/docs/deploymentGuide.md @@ -79,7 +79,7 @@ Open a terminal in the `/backend` directory. 2. Embedding model as `embeddingModelId` 3. API stage (e.x. dev, prod, etc.) as `apiStage` 4. Application name as `applicationName` -All parameters can be set in the [cdk stack](../backend/lib/life-cycle-analysis-chat.ts) as follows: +All parameters can be set in the [cdk stack](../backend/lib/document-chat.ts) as follows: ![](./images/stack_params.png) @@ -92,32 +92,32 @@ cdk bootstrap aws:/// --profile ` with the appropriate AWS profile used earlier. ``` -cdk deploy --all --profile +cdk deploy DocumentChat --parameters githubRepoName=document-chat --profile ``` -## Post-Deployment -### Step 1: Build AWS Amplify App +Once the deployment is complete, you will receive the following output: -Log in to AWS console, and navigate to **AWS Amplify**. You can do so by typing `Amplify` in the search bar at the top. +![deployment output](./images/deployment_output.png) -![AWS Amplify Console](./images/amplify_search.png) +Take note of the `Amplify App ID` as it will be used in the next step. The `Amplify Branch URL` is the public URL you will use to access the web application. -From `All apps`, click `LifeCycleAnalysisChat-...` to go to the app settings. Note down the `App ID`. +## Post-Deployment +### Step 1: Build AWS Amplify App -![image](./images/amplify_app_id.png) +If you'd like to access Amplify details via the AWS Console, you can: +1. Log in to AWS console, and navigate to **AWS Amplify**. You can do so by typing `Amplify` in the search bar at the top. +2. From `All apps`, click `DocumentChat-...`. +There, you have access to the `Amplify App ID` and the public domain name to use the web app. -You may run the following command to build the app. Please replace `` with the app ID found in amplify and `` with the appropriate AWS profile used earlier. +Run the following command to build the app. Please replace `` with the app ID found in amplify and `` with the appropriate AWS profile used earlier. ``` aws amplify start-job --job-type RELEASE --app-id --branch-name main --profile ``` This will trigger the build. -When the build is completed, you will see the screen as shown in the below image. -Please note down the URL highlighted in red, as this will be the URL of the web application. - -![image](./images/amplify_url.png) +When the build is completed, the Amplify console will display a `deployed` status. ### Step 2: Visit Web App -You can now navigate to the URL shown above to see your application in action. +You can now navigate to the web app URL to see your application in action. ## Cleanup ### Taking down the deployed stack @@ -125,5 +125,5 @@ To take down the deployed stack for a fresh redeployment in the future, navigate Alternatively, run the following in the `/backend` folder: ``` -cdk destroy --all --profile +cdk destroy DocumentChat --profile ``` diff --git a/docs/images/amplify_app_id.png b/docs/images/amplify_app_id.png deleted file mode 100644 index 887fef4..0000000 Binary files a/docs/images/amplify_app_id.png and /dev/null differ diff --git a/docs/images/amplify_search.png b/docs/images/amplify_search.png deleted file mode 100644 index be41678..0000000 Binary files a/docs/images/amplify_search.png and /dev/null differ diff --git a/docs/images/deployment_output.png b/docs/images/deployment_output.png new file mode 100644 index 0000000..7a0136b Binary files /dev/null and b/docs/images/deployment_output.png differ diff --git a/docs/images/stack_params.png b/docs/images/stack_params.png index b2286e4..39bba7c 100644 Binary files a/docs/images/stack_params.png and b/docs/images/stack_params.png differ