Skip to main content

Documentation for the Codecurate platform

Codecurate Docs

Backend reference, operations, and future frontend guides for Codecurate

Both sides of Codecurate are documented now. The backend pages cover setup, authentication, media workflows, FFmpeg automation, compare jobs, and TMDB integration, while the frontend pages describe the React app shell, route map, OIDC flow, API integration, and user-facing workflows.

Read backend docsSee frontend structure
BackendDocumented

Runtime architecture, operations, endpoint groups, and deployment notes.

FrontendDocumented

Application structure, auth flow, service layer, and workflow guides.

SecurityJWT + allowed client checks
OperationsMongoDB, watchers, FFmpeg queue
ReferenceOpenAPI at `/api/docs` and `/api/docs-yaml`

Start where you are working

A docs structure built around the current product split

The backend pages are written for operators and integrators, while the frontend pages cover the React application shell, integration patterns, and user-facing workflows.

01

Deploy the backend

Install prerequisites, configure the environment, and get the API online on port 5000.

Includes local development, Docker notes, and every current backend environment variable.

Open section
02

Run media workflows

Understand indexing, filtering, uploads, secure downloads, file rename, and delete behavior.

The docs map the API to the actual watcher, reconciliation, and storage behavior in the backend.

Open section
03

Understand the frontend app

Follow the React shell, OIDC authentication flow, service wrappers, and page-level user workflows.

The frontend docs tie the route structure and UI behavior back to the backend contracts they consume.

Open section