Skip to content
Amaroad

Installation

Clone the Amaroad repository and install dependencies to start creating slides.

Prerequisites

  • Node.js 22.13 or later
  • pnpm (enable via corepack enable pnpm)
  • An AI coding agent (Claude Code, Codex CLI, Gemini CLI, Cursor, etc.)

Install Amaroad

1

Clone the repository

bash
git clone git@github.com:co-r-e/amaroad.git amaroad
cd amaroad
2

Install dependencies

bash
pnpm install
3

Start the development server

bash
pnpm run dev

The homepage is available at http://localhost:3850, listing all decks in the decks/ directory.

Verify Installation

Open your browser and navigate to http://localhost:3850. You should see the Amaroad homepage listing available decks. Click on a deck name (e.g., sample-deck) to view it.

Project Structure

  • decks/ — Each subdirectory is a separate deck with its own deck.config.ts and MDX slide files.
  • deck.config.ts — Per-deck configuration (title, theme, logo, copyright, etc.).
  • src/components/mdx/ — Built-in slide components (charts, layouts, showcase templates).
Quick Start

Create your first deck in under 5 minutes.