Documentation

Setup Guide

Get Cinder up and running in minutes with this comprehensive setup guide.

Installation

1

Clone the Repository

Get the latest source code from GitHub.

git clone https://github.com/Michael-Obele/cinder-sv.git
cd cinder-sv
2

Install Dependencies

Use Bun for faster installation and better performance.

bun install

Note: If using npm or pnpm, adjust the commands accordingly.

3

Configure Environment Variables

Copy the example environment file and update it with your backend details.

cp .env.example .env.local

# Edit .env.local with:
PRIVATE_CINDER_BACKEND_URL=http://localhost:8000
PRIVATE_CINDER_API_KEY=your-api-key-here
4

Run Development Server

Start the local development server with hot-reloading.

bun run dev

Next Steps

Try the Playground

Test your connection by scraping a URL in the playground.

Read Architecture

Learn how the frontend communicates with the backend.