History

Andrew Lalis e0edfb8d68 Added build script.		2023-04-02 12:05:07 +02:00
..
source	Add account deletion, data requests, and more.	2023-03-31 19:02:46 +02:00
.gitignore	Added uploads service stub	2023-03-29 17:29:19 +02:00
README.md	Added build script.	2023-04-02 12:05:07 +02:00
dub.json	Add account deletion, data requests, and more.	2023-03-31 19:02:46 +02:00
dub.selections.json	Add account deletion, data requests, and more.	2023-03-31 19:02:46 +02:00

README.md

Gymboard Uploads

A service for handling large file uploads and processing. This service manages user-submitted video files, processing of the video files, and rapidly serving the raw file content.

Upload Logical Flow

When a user is creating a new Gymboard submission, they need to upload their video, which must be processed to compress and prepare it for web usage. The following series of steps describe how this is done.

User uploads raw video to gymboard-uploads, receives an upload-id.
User posts the submission, including the upload-id, to gymboard-api.
gymboard-api validates the submission, then sends a request to gymboard-uploads to start processing the video identified by upload-id, and marks the submission as processing.
gymboard-uploads processes the video, and upon completion, sends a request to gymboard-api indicating that the processed video is available at video-url.
gymboard-api updates the user's submission to include the video-url, and marks the submission as no longer processing.

Therefore, gymboard-uploads is responsible for the following actions:

Receiving raw video uploads from users and storing them temporarily until gymboard-api requests that we start processing, or they'll be discarded.
Processing of raw videos to reduce file size and optimize for web. This will most likely be done using FFMPEG in the backend.
Reporting the status of video processing for recently uploaded videos.
Serving processed video files.

THIS PROJECT IS A WORK-IN-PROGRESS Do not use it for production.