Skip to content

Update readme #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JingLin0 merged 2 commits into from
Oct 11, 2025
Merged

Update readme #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5634554
add cors origin for production app
JingLin0 Oct 11, 2025
85f917d
update readme
JingLin0 Oct 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 17 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,26 @@
# video-logo-tracker (code challenge)
# video-logo-tracker

This is a code challenge for a video logo tracker.
⚙️ Overview

It consists of two parts:

1. API
2. Worker
The system consists of two main components:

## API

The API is a FastAPI application deployed on GCP cloud run that allows you to upload a video and a logo, and then process the video to detect the logo.
A FastAPI application deployed on Google Cloud Run.
It allows users to:

- Upload a video and a logo image.
- Trigger cloud function that processes the video to detect occurrences of the logo.

## Worker

The Worker is a Cloud Function deployed on GCP that processes the video to detect the logo using the SIFT algorithm.
A Google Cloud Function responsible for the actual video processing.
It uses the SIFT (Scale-Invariant Feature Transform) algorithm to:

- Detect the logo in individual frames.

- Generate an output video with detected logo regions highlighted.

🚀 Live Demo

Visit the APP
🔗 Visit the App: https://neurons-code-challenge.lovable.app/
1 change: 1 addition & 0 deletions api/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ async def lifespan(app: FastAPI):
allow_origins=[
"https://8a33b7dc-2d6d-43a9-af02-5ff81682d7f1.lovableproject.com",
"https://id-preview--8a33b7dc-2d6d-43a9-af02-5ff81682d7f1.lovable.app",
"https://neurons-code-challenge.lovable.app",
],
allow_methods=["*"],
allow_headers=["*"],
Expand Down