Character Platform

Project documentation hub

All the core documents for deployment and operations are gathered here. Review them to quickly understand the project context.

API GUIDE

A guide to the REST and WebSocket interfaces.

Path: docs/API_GUIDE.md

Architecture

Visualizes the overall system architecture and dependencies.

Path: docs/architecture.md

ENV SETUP GUIDE

Docs.descriptions.ENV_SETUP_GUIDE_md

Path: docs/ENV_SETUP_GUIDE.md

Railway Deployment

Docs.descriptions.railway-deployment_md

Path: docs/railway-deployment.md

README SUPABASE

Docs.descriptions.README_SUPABASE_md

Path: docs/README_SUPABASE.md

START SERVER

Docs.descriptions.START_SERVER_md

Path: docs/START_SERVER.md

Structure

Explains the project folder structure and code organization principles.

Path: docs/structure.md

Task

Tracks ongoing work and completed tasks.

Path: docs/task.md

Task Done

Docs.descriptions.task_done_md

Path: docs/task_done.md

WEBSOCKET PROTOCOL

Describes the WebSocket message specification for real-time interactions.

Path: docs/WEBSOCKET_PROTOCOL.md