https://github.com/rishabkumar7/devops-qr-code

This is the sample application for the DevOps Capstone Project. It generates QR Codes for the provided URL, the front-end is in NextJS and the API is written in Python using FastAPI.
https://github.com/rishabkumar7/devops-qr-code

capstone-project devops

Last synced: 2 days ago
JSON representation

This is the sample application for the DevOps Capstone Project. It generates QR Codes for the provided URL, the front-end is in NextJS and the API is written in Python using FastAPI.

• Host: GitHub
• URL: https://github.com/rishabkumar7/devops-qr-code
• Owner: rishabkumar7
• License: mit
• Created: 2023-12-12T17:32:33.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-07-30T18:22:29.000Z (4 months ago)
• Last Synced: 2024-07-30T22:49:29.358Z (4 months ago)
• Topics: capstone-project, devops
• Language: JavaScript
• Homepage:
• Size: 22.5 KB
• Stars: 27
• Watchers: 2
• Forks: 41
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# devops-qr-code

This is the sample application for the DevOps Capstone Project.

It generates QR Codes for the provided URL, the front-end is in NextJS and the API is written in Python using FastAPI.

## Application

**Front-End** - A web application where users can submit URLs.

**API**: API that receives URLs and generates QR codes. The API stores the QR codes in cloud storage(AWS S3 Bucket).

## 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 you 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`

## Goal

The goal is to get hands-on with DevOps practices like Containerization, CICD and monitoring.

Look at the capstone project for more detials.

## Author

[Rishab Kumar](https://github.com/rishabkumar7)

## License

[MIT](./LICENSE)