A web app that converts a URL to a QR Code. The app has three components: Front-end, API and Storage. All 3 components should be hosted in containers utilizing the cloud provider of your choice. The sample application code is provided, your goals is to apply DevOps practices like containerization, CI/CD, observability and monitoring for the application.

• Front-End Container: Hosts the website where users can input URLs.
• API Container: Handles the QR code generation for given URLs.
• Storage Container: Stores the generated QR codes.

DevOps Practices

• Docker: Used for containerizing the front-end (Next.js) and API (FastAPI) to ensure consistent deployment across environments.

• GitHub Actions: Implements CI/CD pipelines to automate the deployment of containers when source code changes occur.

• Terraform: Manages and provisions cloud infrastructure, specifically creating a Kubernetes cluster using Infrastructure as Code (IaC).

• Kubernetes: Orchestrates the deployment and management of containerized applications, ensuring scalability and high availability.

• AWS S3: Provides secure storage for generated QR codes, allowing for persistent data storage and easy accessibility.

• Amazon CloudWatch: Monitors container metrics, providing insights for performance and operational monitoring.

• Grafana: Enhances observability by visualizing metrics collected from the application, aiding in performance monitoring and troubleshooting.

Project Workflow

Running locally

API

The API code exists in the api directory. You can run the API server locally:

• Clone this repo
• 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 .env file, and add your AWS Access and Secret key, check .env.example
• 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

Front-end

The front-end code exits in the front-end-nextjs directory. You can run the front-end server locally:

• Clone this repo
• Make sure you are in the front-end-nextjs directory
• Install the dependencies: npm install
• Run the NextJS Server: npm run dev
• Your Front-end Server should be running on http://localhost:3000

Author

Rishab Kumar

License

MIT