Skip to content
/ BCO Public

Code Repository for Breast Cancer Organisation

Notifications You must be signed in to change notification settings

ASUCICREPO/BCO

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 

Repository files navigation

Breast Cancer Organization Chatbot Repository

Welcome to the Breast Cancer Organization (BCO) Chatbot repository! This guide will walk you through the process of setting up and deploying the project using AWS CDK.

⚙️ Prerequisites

Ensure that the following tools are installed before proceeding:

  • AWS CLI: version 2.15.41
  • AWS CDK: version 2.170.0
npm install
sudo npm install -g aws-cdk

🚀 Let's Get Started!

Step 1: Initial Setup

  1. 🍴 Fork the Repository

    • Go to the repository on GitHub and click the Fork button in the top-right corner.
  2. 🔐 Create a Personal Access Token (PAT)

    • Navigate to Settings in GitHub.
    • Scroll down to Developer Settings.
    • Click Personal Access Tokens, and select Tokens (classic).
    • Click Generate New Token (classic).
    • Add a note like BCO_Chatbot to identify the token.
    • Set an expiration period that suits your needs.
    • Select the following scopes:
      • repo (Full control of private repositories)
      • repo_hook (Manage webhooks)
    • Click Generate Token and store it securely for later use.

🔧 Step 2: Setup Instructions

  1. 📂 Clone the Forked Repository
    git clone <your-forked-repo-link>
    
    
    
  2. 📁 Navigate to the CDK Folder
cd BCO/CDK
  1. 📦 Deploy the Application Using CDK
cdk bootstrap -c githubToken=$stored-github-token githubOwner=$github-owner-of-repo
cdk synth -c githubToken=$stored-github-token githubOwner=$github-owner-of-repo
cdk deploy -c githubToken=$stored-github-token githubOwner=$github-owner-of-repo

🏁 Almost There!

Post-Deployment Instructions

  1. 🔍 Access the Amplify App in the AWS Console

    • Navigate to the Amplify service in your AWS Management Console.
    • Find and select the newly created BCO Chatbot app.
  2. 🚀 Start the GitHub App Migration

    • If prompted with a migration popup, click Start Migration to begin the setup process.
    • This ensures proper GitHub integration for continuous deployment.
  3. 🔧 Configure the GitHub App

    • Follow the steps to configure the GitHub App for your repository.
    • Complete the installation by selecting your repository and authorizing access.
  4. 🏗️ Run the Amplify Build Job

    • After configuring the GitHub App, return to the Amplify console.
    • Select your app, and click Run Job to trigger the deployment pipeline.
    • The job will build and deploy your chatbot automatically.
  5. 🌐 Access Your Deployed Chatbot

    • Once the deployment is completed, Amplify will provide a domain link.
    • Click the link to access your live BCO Chatbot.

🎉 Congratulations!!

Your BCO Chatbot has been successfully deployed! You can now explore your chatbot and start using it for breast cancer awareness and support.

About

Code Repository for Breast Cancer Organisation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published