added GH Action for docker

Author: SilasCloud

.DS_Store

@@ -0,0 +1,15 @@
+name: Publish Docker image to Docker Hub
+on:
+  [workflow_dispatch:]
+
+jobs:
+  publish_images:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Build image
+        run: docker build ./api/ -t echelonkay/devops-qr-code-api:latest
+      - name: push image to docker hub
+        run: |
+            docker push echelonkay/devops-qr-code-api:latest

.github\workflows/workflows/build-docker.yaml

@@ -16,14 +16,36 @@ It generates QR Codes for the provided URL, the front-end is in NextJS and the A
 The API code exists in the `api` directory. You can run the API server locally:
 
 - Clone this repo
+- Create a AWS User with AmazonS3FullAccess 
+- Create a S3 Bucket and select ACL enable for public access, Uncheck block bucket.
 - Make sure you are in the `api` directory
-- Create a virtualenv by typing in the following command: `python -m venv .venv`
-- Install the required packages: `pip install -r requirements.txt`
+- Create a virtualenv by typing in the following command: `python3 -m venv .venv`
+- Run command `source .venv/bin`
+- Run command `source .venv/bin/activate`
+- Install the required packages: `pip install -r requirements.txt` 'or pip install fastapi uvicorn boto3 python-dotenv pytest qrcode' 
 - Create a `.env` file, and add you AWS Access and Secret key, check  `.env.example`
+- and Save the Access & secret key, cat the `.env` to verify. 
 - Also, change the BUCKET_NAME to your S3 bucket name in `main.py`
 - Run the API server: `uvicorn main:app --reload`
 - Your API Server should be running on port `http://localhost:8000`
 
+### optional- Troubleshoting S3 bucket
+### you might add Bucket policy 
+
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Sid": "PublicReadGetObject",
+            "Effect": "Allow",
+            "Principal": "*",
+            "Action": "s3:GetObject",
+            "Resource": "arn:aws:s3:::YOUR_BUCKET_NAME/*"  # Add bucket name 
+        }
+    ]
+}
+
+
 ### Front-end
 
 The front-end code exits in the `front-end-nextjs` directory. You can run the front-end server locally:

README.md

@@ -0,0 +1,65 @@
+from fastapi import FastAPI, HTTPException
+from fastapi.middleware.cors import CORSMiddleware
+import qrcode
+import boto3
+import os
+from io import BytesIO
+
+# Loading Environment variable (AWS Access Key and Secret Key)
+from dotenv import load_dotenv
+load_dotenv()
+
+app = FastAPI()
+
+# Allowing CORS for local testing
+origins = [
+    "http://localhost:3000"
+]
+
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=origins,
+    allow_methods=["*"],
+    allow_headers=["*"],
+)
+
+# AWS S3 Configuration
+s3 = boto3.client(
+    's3',
+    aws_access_key_id= os.getenv("AWS_ACCESS_KEY"),
+    aws_secret_access_key= os.getenv("AWS_SECRET_KEY"))
+
+bucket_name = 'capstone-qr-code-bucket' # Add your bucket name here
+
+@app.post("/generate-qr/")
+async def generate_qr(url: str):
+    # Generate QR Code
+    qr = qrcode.QRCode(
+        version=1,
+        error_correction=qrcode.constants.ERROR_CORRECT_L,
+        box_size=10,
+        border=4,
+    )
+    qr.add_data(url)
+    qr.make(fit=True)
+
+    img = qr.make_image(fill_color="black", back_color="white")
+    
+    # Save QR Code to BytesIO object
+    img_byte_arr = BytesIO()
+    img.save(img_byte_arr, format='PNG')
+    img_byte_arr.seek(0)
+
+    # Generate file name for S3
+    file_name = f"qr_codes/{url.split('//')[-1]}.png"
+
+    try:
+        # Upload to S3
+        s3.put_object(Bucket=bucket_name, Key=file_name, Body=img_byte_arr, ContentType='image/png', ACL='public-read')
+        
+        # Generate the S3 URL
+        s3_url = f"https://{bucket_name}.s3.amazonaws.com/{file_name}"
+        return {"qr_code_url": s3_url}
+    except Exception as e:
+        raise HTTPException(status_code=500, detail=str(e))
+    

api/*

@@ -1,2 +1,2 @@
-AWS_ACCESS_KEY=Your-AWS-Access-Key
-AWS_SECRET_KEY=Your-AWS-Secret-Access-Key
+#AWS_ACCESS_KEY=Your-AWS-Access-Key
+#AWS_SECRET_KEY=Your-AWS-Secret-Access-Key

api/.DS_Store

@@ -0,0 +1,17 @@
+# Use the official image as a parent image
+FROM python:3.9
+
+# Set the working directory in the container
+WORKDIR /urs/src/app
+
+# Copy the dependencies file to the working directory
+COPY requirements.txt ./
+
+# Install any needed packages specified in requirements.txt
+RUN pip install --no-cache-dir -r requirements.txt
+
+# Copy the content of the local src directory to the working directory
+COPY . .
+
+# Run the application
+CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "80"]

api/.env.example

@@ -4,16 +4,16 @@
 import boto3
 import os
 from io import BytesIO
-
-# Loading Environment variable (AWS Access Key and Secret Key)
 from dotenv import load_dotenv
+
+# Load environment variables (AWS Access Key and Secret Key)
 load_dotenv()
 
 app = FastAPI()
 
 # Allowing CORS for local testing
 origins = [
-    "http://localhost:3000"
+    "http://localhost:3000"  # Update with your frontend URL if needed
 ]
 
 app.add_middleware(
@@ -26,10 +26,11 @@
 # AWS S3 Configuration
 s3 = boto3.client(
     's3',
-    aws_access_key_id= os.getenv("AWS_ACCESS_KEY"),
-    aws_secret_access_key= os.getenv("AWS_SECRET_KEY"))
+    aws_access_key_id=os.getenv("AWS_ACCESS_KEY"),
+    aws_secret_access_key=os.getenv("AWS_SECRET_KEY")
+)
 
-bucket_name = 'YOUR_BUCKET_NAME' # Add your bucket name here
+bucket_name = 'capstone-qr-code-bucket'  # Replace with your S3 bucket name
 
 @app.post("/generate-qr/")
 async def generate_qr(url: str):
@@ -54,12 +55,18 @@ async def generate_qr(url: str):
     file_name = f"qr_codes/{url.split('//')[-1]}.png"
 
     try:
-        # Upload to S3
-        s3.put_object(Bucket=bucket_name, Key=file_name, Body=img_byte_arr, ContentType='image/png', ACL='public-read')
+        # Upload to S3 (removed ACL='public-read' as it caused the error)
+        s3.put_object(
+            Bucket=bucket_name,
+            Key=file_name,
+            Body=img_byte_arr,
+            ContentType='image/png'
+        )
 
         # Generate the S3 URL
         s3_url = f"https://{bucket_name}.s3.amazonaws.com/{file_name}"
         return {"qr_code_url": s3_url}
+
     except Exception as e:
-        raise HTTPException(status_code=500, detail=str(e))
-    
+        # Log error and raise HTTPException
+        raise HTTPException(status_code=500, detail=f"Error generating QR code: {str(e)}")

api/Dockerfile

@@ -4,14 +4,18 @@
 client = TestClient(app)
 
 def test_generate_qr():
-    url = "http://example.com"
+    url = "https://example.com"  # Use a valid URL here
     response = client.post("/generate-qr/", json={"url": url})
-
+    
+    # Check that the response status code is 200 (OK)
     assert response.status_code == 200
+    
+    # Check that the response contains the 'qr_code_url' field
     assert "qr_code_url" in response.json()
 
 def test_generate_qr_invalid_url():
-    url = "invalid-url"
+    url = "invalid-url"  # Invalid URL
     response = client.post("/generate-qr/", json={"url": url})
 
-    assert response.status_code == 422  # FastAPI validation error
+    # FastAPI validation should return status 422 for invalid input
+    assert response.status_code == 422  

api/main.py

@@ -0,0 +1,29 @@
+# Use the official lightweight Node.js 18 image
+FROM node:18-alpine AS base
+
+# Set the working directory in the container
+WORKDIR /app
+
+# Copy the package files
+COPY package.json yarn.lock* package-lock.json* pnpm-lock.yaml* ./
+
+# Copy the install-dependencies.sh script
+COPY install-dependencies.sh ./
+
+# Install dependencies using the script
+RUN ./install-dependencies.sh
+
+# Copy the rest of the application code
+COPY . .
+
+# Expose the application port
+EXPOSE 3000
+
+# Start the application
+CMD ["npm", "start"]
+
+# Build the Next.js app
+RUN npm run build
+
+# Expose the build folder
+COPY .next ./.next