Installation

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

Prerequisites

Node.js 18 or later
npm (included with Node.js)
An AI coding agent (Claude Code, Codex CLI, Gemini CLI, Cursor, etc.)

Install Amaroad

Clone the repository

bash

git clone [email protected]:co-r-e/amaroad.git amaroad
cd amaroad

Install dependencies

bash

npm install

Start the development server

bash

npm run dev

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

Verify Installation

Open your browser and navigate to http://localhost:3000. 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.