{"id":28148865,"url":"https://github.com/suraj-kumar00/devops-url2qr","last_synced_at":"2026-02-16T10:39:13.209Z","repository":{"id":255280163,"uuid":"843423483","full_name":"Suraj-kumar00/DevOps-URL2QR","owner":"Suraj-kumar00","description":"Building DevOps Capstone Project that generetes QR Codes for the provided URL.","archived":false,"fork":false,"pushed_at":"2026-01-25T06:18:21.000Z","size":7065,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-25T21:06:28.586Z","etag":null,"topics":["api","aws","capstone-project","cicd","devops","docker","fastapi","github-actions","iac","kubernetes","nextjs","observability","python","s3-bucket"],"latest_commit_sha":null,"homepage":"https://devopsqr.surajdev.tech","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"rishabkumar7/devops-qr-code","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Suraj-kumar00.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-08-16T13:35:46.000Z","updated_at":"2026-01-25T06:25:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"0abe97b5-fec8-4330-93e6-1ff3d21956ab","html_url":"https://github.com/Suraj-kumar00/DevOps-URL2QR","commit_stats":null,"previous_names":["suraj-kumar00/devops-url2qr"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/Suraj-kumar00/DevOps-URL2QR","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Suraj-kumar00%2FDevOps-URL2QR","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Suraj-kumar00%2FDevOps-URL2QR/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Suraj-kumar00%2FDevOps-URL2QR/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Suraj-kumar00%2FDevOps-URL2QR/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Suraj-kumar00","download_url":"https://codeload.github.com/Suraj-kumar00/DevOps-URL2QR/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Suraj-kumar00%2FDevOps-URL2QR/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29506255,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-16T09:05:14.864Z","status":"ssl_error","status_checked_at":"2026-02-16T08:55:59.364Z","response_time":115,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","aws","capstone-project","cicd","devops","docker","fastapi","github-actions","iac","kubernetes","nextjs","observability","python","s3-bucket"],"created_at":"2025-05-15T01:14:51.661Z","updated_at":"2026-02-16T10:39:13.186Z","avatar_url":"https://github.com/Suraj-kumar00.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![DevOps-URL2QR Project](./Assets/DevOPs-url2qr.png)\n\nThis project focuses on creating a streamlined solution for generating QR codes from user-provided URLs. It features a user-friendly `Next.js` front end for URL input, a robust `FastAPI` backend for QR code generation, and a secure storage system for saving the generated codes.\n\n- `Front-End Container:` User-facing website for URL input.\n- `API Container:` Backend service for QR code generation.\n- `Storage Container:` Secure storage for generated QR codes.\n\n## Branches\n\n| Branch | Description |\n|--------|-------------|\n| `main` (default) | Contains the application code with DevOps practices implementation |\n| `devops` | Contains the DevOps practices implementation code as well |\n\n\n## Cloud \u0026 DevOps Practices\n\n- **`Docker`**: Used for containerizing the front-end (Next.js) and API (FastAPI) to ensure consistent deployment across environments.\n\n- **`GitHub Actions`**: Implements CI/CD pipelines to automate the deployment of containers when source code changes occur.\n\n- **`Terraform`**: Manages and provisions cloud infrastructure, specifically creating a Kubernetes cluster using Infrastructure as Code (IaC).\n\n- **`Kubernetes`**: Orchestrates the deployment and management of containerized applications, ensuring scalability and high availability.\n  - **`KIND(Kubernetes in Docker)`** Deploying application to test the functionality localy using Kind Cluster. \n  - **`AWS EKS`**: Deploying the application on prodcution using AWS EKS cluster. \n\n- **`AWS S3`**: Provides secure storage for generated QR codes, allowing for persistent data storage and easy accessibility.\n\n- **`Prometheus`**: Monitors container and system metrics, offering real-time insights for performance and operational monitoring.\n\n- **`Grafana`**: Visualizes metrics collected from Prometheus and other sources, enhancing observability and aiding in performance monitoring and troubleshooting.\n\n## Project Workflow\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"./Assets/DevOpsURL2QR.png.drawio.svg\" alt=\"DevOps URL2QR Project Workflow\"\u003e\n\u003c/div\u003e\n\n## End to End CI/CD Pipeline\n\n![CICD Pipeline](./Assets/CICD-Pipeline.png)\n\n## Quick Start with Docker \n\nThis is the fastest way to get the application running on your local machine.\n\n### Prerequisites\n\n- Docker Desktop / Docker Daemon installed on your machine\n- Git (to clone the repository)\n\n### Steps to Run with Docker\n\n1. **Clone the repository**\n   ```bash\n   git clone \u003crepository-url\u003e\n   cd DevOps-URL2QR\n   ```\n\n2. **First-time setup**\n   ```bash\n   docker compose up --build\n   ```\n   This command will:\n   - Build all container images\n   - Create necessary networks\n   - Start all services\n   - The frontend will be available at http://localhost:3000\n   - The backend API will be available at http://localhost:8000\n\n3. **Subsequent runs**\n   ```bash\n   docker compose up\n   ```\n   Use this command when you haven't made any changes to the Dockerfile or dependencies.\n\n4. **Stop the application**\n   ```bash\n   docker compose down\n   ```\n   This will stop and remove all containers, but preserve your images.\n\n### Additional Docker Commands\n\n- To view logs of a specific service:\n  ```bash\n  docker compose logs frontend  # For frontend logs\n  docker compose logs backend   # For backend logs\n  ```\n\n- To rebuild a specific service:\n  ```bash\n  docker compose up --build frontend  # Rebuild frontend only\n  docker compose up --build backend   # Rebuild backend only\n  ```\n\n- To remove all containers and images (clean slate):\n  ```bash\n  docker compose down --rmi all\n  ```\n\n### Troubleshooting\n\n- If you see connection errors, ensure all services are up:\n  ```bash\n  docker compose ps\n  ```\n\n- If the frontend can't connect to the backend, check the logs:\n  ```bash\n  docker compose logs backend\n  ```\n\n## Running the project locally\n\n### Run the Backend\n\nThe Backend code exists in the `api` directory. You can run the API server locally:\n\n1. Clone this repo\n\n```bash\ngit clone \u003crepository-url\u003e\n```\n\n2. Make sure you are in the `api` directory\n\n```bash\ncd api\n```\n\n3. Create a virtualenv by typing in the following command:\n\n```bash\npython -m venv .venv\n```\n\n4. Install the required packages:\n\n```bash\npip install -r requirements.txt\n```\n\n5. Create a `.env` file, and add your AWS Access and Secret key, check `.env.example` just run the below command\n\n```bash\ncp .env.example .env\n```\n\n6. Also, change the BUCKET_NAME to your S3 bucket name in `main.py`\n7. Run the API server:\n\n```bash\nuvicorn main:app --reload\n```\n\n8. Your API Server should be running on port\n   [ `http://localhost:8000`](http://localhost:8000)\n\n### Run the Front-end\n\nThe front-end code exits in the `front-end-nextjs` directory. You can run the front-end server locally:\n\n1. Make sure you are in the `front-end-nextjs` directory\n\n```bash\ncd front-end-nextjs\n```\n\n2. Install the dependencies:\n\n```bash\nnpm install\n```\n\n3. Run the NextJS Server:\n\n```bash\nnpm run dev\n```\n\n4. Your Front-end Server should be running on [`http://localhost:3000`](`http://localhost:3000`)\n\n## This project is inpired by\n\n[Rishab Kumar](https://github.com/rishabkumar7)\n\n## Star 🌟 the project\n\nIf you like this project so far don't forget to star 🤩 the project for future reference.\n\n## License\n\n[MIT](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuraj-kumar00%2Fdevops-url2qr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsuraj-kumar00%2Fdevops-url2qr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuraj-kumar00%2Fdevops-url2qr/lists"}