workflow fix

shubhankarunhale · Jul 25, 2024 · 34f29fd · 34f29fd
1 parent d981d12
commit 34f29fd
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 46 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -79,8 +79,8 @@ jobs:
           export FRONTEND_STACK_EXPORTS_AVAILABLE=true
           npx cdk deploy BackendStack --require-approval never
       
-       - name: Get DeploymentURL
-        id: get-deplloyment-url
+      - name: Get DeploymentURL
+        id: get-deployment-url
         run: |
           deployment_url=$(aws cloudformation list-exports --query "Exports[?Name=='CloudfrontURL'].Value" --output text)
-          echo "Access the deployment at: ${deployment_url}"
+          echo "Access the deployment at: ${deployment_url}"
diff --git a/cdk/README.md b/cdk/README.md
@@ -54,49 +54,29 @@ The most important and unique aspect of this application is its ability to dynam
 
 ## Getting Started
 
-To set up the project locally:
-
-1. **Clone the Repository**:
-    ```bash
-    git clone https://github.com/yourusername/AWS-S3-Secure-File-Manager-Starter.git
-    cd AWS-S3-Secure-File-Manager-Starter
-    ```
-
-2. **Install Dependencies**:
-
-    - **For the frontend**:
-        ```bash
-        cd frontend
-        npm install
-        cd ..
-        ```
-
-    - **For the backend (CDK)**:
-        ```bash
-        cd cdk
-        npm install
-        ```
-
-3. **Configure AWS CLI**:
-   Ensure AWS CLI is configured with your credentials:
-    ```bash
-    aws configure
-    ```
-
-4. **Deploy the Application**:
-    - Run the deployment script:
-        ```bash
-        ./deploy.sh
-        ```
-
-5. **Run the Application Locally**:
-    - Start the frontend:
-        ```bash
-        cd frontend
-        npm start
-        ```
-
-    - Open [http://localhost:3000](http://localhost:3000) in your browser.
+### Prerequisites
+
+- Node.js (v14 or later)
+- AWS CLI
+- AWS CDK (v2)
+- GitHub account
+
+### Deploy Using GitHub Actions
+
+1. **Fork the Repository:**
+   Fork this repository to your GitHub account.
+
+2. **Add Secrets:**
+   Add the required parameters to the secrets in your GitHub repository settings. Navigate to `Settings > Secrets > Actions` and add the following secrets:
+
+   - `AWS_ACCESS_KEY_ID`
+   - `AWS_SECRET_ACCESS_KEY`
+   - `AWS_REGION`
+   - `S3_BUCKET_NAME`
+
+3. **Push Changes:**
+   Push any changes to your forked repository. This will trigger the GitHub Actions workflow to deploy your application.
+
 
 ## License