Getting Started

Getting Started

This guide covers local development setup. For production deployment, see Installation or Docker Deployment.

---

Prerequisites

• Node.js 20+
• Cloudflare account
• Git

---

Local Development

1. Clone the Repository

git clone https://github.com/neverinfamous/do-manager.git
cd do-manager

2. Install Dependencies

npm install

3. Initialize Local Database

npx wrangler d1 execute do-manager-metadata-dev --local --file=worker/schema.sql

4. Start Development Servers

You need two terminals:

Terminal 1 — Frontend (Vite)

npm run dev

Terminal 2 — Worker (Wrangler)

npx wrangler dev --config wrangler.dev.toml --local

5. Open the App

Navigate to http://localhost:5173

• No authentication required in dev mode
• Mock data is included for testing

---

Project Structure

do-manager/
├── src/                    # Frontend React app
│   ├── components/
│   │   ├── ui/             # shadcn components
│   │   ├── layout/         # Header, navigation
│   │   └── features/       # Feature components
│   ├── contexts/           # React contexts (theme)
│   ├── hooks/              # Custom hooks
│   ├── services/           # API clients
│   ├── types/              # TypeScript types
│   └── App.tsx
├── worker/                 # Cloudflare Worker backend
│   ├── routes/             # API route handlers
│   ├── types/              # Worker types
│   ├── utils/              # Utilities
│   ├── schema.sql          # D1 schema
│   └── index.ts            # Worker entry
└── ...config files

---

Next Steps

• Full Installation Guide — Production deployment with Cloudflare Access
• Docker Deployment — Run with Docker
• Admin Hooks — Enable storage management for your DOs
• Features — Explore all capabilities