Getting Started

Project Structure

Overview of the Cortex project directory structure and key components.

Overview

Cortex follows a modular monorepo structure that separates concerns between the core analytics engine, API server, and Studio interface.

Directory Structure

cortex/
├── cortex/                    # Python package
│   ├── api/                   # FastAPI application
│   │   ├── routers/          # API route definitions
│   │   ├── schemas/          # Pydantic request/response models
│   │   └── main.py           # FastAPI app entry point
│   │
│   ├── core/                 # Core business logic
│   │   ├── connectors/       # Database Connectors
│   │   ├── consumers/        # User Management
│   │   ├── dashboards/       # Dashboard Management
│   │   ├── data/             # Data Models and Sources
│   │   ├── query/            # Query Engine
│   │   ├── semantics/        # Semantic Definitions
│   │   ├── stores/           # Data Persistence
│   │   ├── types/            # Type Definitions
│   │   └── workspaces/       # Environments and workspaces
│   │
│   └── migrations/           # Alembic database migrations
│       ├── alembic/          # Migration scripts
│       └── alembic.ini       # Alembic configuration
│
├── frontend/cortex/          # Studio Interface
│   ├── app/                  # Nuxt.js Application
│   │   ├── components/       # Vue Components
│   │   ├── composables/      # Reusable business logic
│   │   ├── pages/            # Route pages
│   │   └── types/            # TypeScript types
│   │
│   ├── package.json          # Frontend dependencies
│   └── nuxt.config.ts        # Nuxt configuration
│
├── pyproject.toml           # Python dependencies
└── README.md                # Project documentation