Codecurate Documentation

This site is organized so backend and frontend documentation can grow independently without having to reshuffle the navigation later.

Both the backend and frontend sections are now documented from the current codebases. The split is still intentional: backend pages remain the source of truth for API and operational behavior, while frontend pages focus on application structure, auth flow, API integration, and user workflows.

Documentation map

• Backend overview explains the runtime architecture, storage model, and major services.
• Getting started covers prerequisites, configuration, local development, and Docker notes.
• Authentication and access explains JWT requirements, client restrictions, CORS, and secure downloads.
• Media library documents indexing, querying, uploads, renames, deletes, and filter syntax.
• Automation and FFmpeg covers command presets, job lifecycle, worker modes, and queue behavior.
• Compare and obtain documents metadata compare, VMAF workflows, history, and TMDB-backed obtain flows.
• API reference is the endpoint-by-endpoint quick lookup.
• Frontend overview explains the React application shell, route map, and major feature areas.
• Frontend getting started covers prerequisites, scripts, environment variables, and OpenAPI generation.
• Frontend authentication and API documents OIDC, silent renew, unauthorized retry behavior, and generated client usage.
• Frontend workflows maps the main pages to backend capabilities and user flows.

Start here

If you are deploying or developing the backend first, read these pages in order:

1. Backend overview
2. Getting started
3. Authentication and access
4. Media library

If you are integrating a client application, the fastest path is:

1. Authentication and access
2. API reference
3. Compare and obtain

Current backend scope

• ASP.NET Core API hosted on port 5000
• MongoDB-backed metadata, queue, compare, and obtain storage
• Background media indexing with file watching and periodic reconciliation
• FFmpeg command preset execution with local and Docker worker modes
• Metadata compare and queued VMAF calculation workflows
• TMDB-backed search, translations, titles, and obtain-list automation

Notes for future frontend docs

The frontend section is now documented at a high level and already has room for deeper additions such as:

• application architecture and page map
• authentication flow and token handling
• API client usage against the backend documented here
• media, compare, command, and obtain user workflows

When frontend docs are added, the backend pages can remain stable and keep acting as the source of truth for the API and operational behavior.