create-oggtheme

Scaffold Oggtheme — a Cyberpunk Hacker Night admin dashboard template.

React 18 · TypeScript · Vite 6 · React Router · Tailwind CSS · Recharts · Lucide Icons

Quick Start

# Recommended
npm create oggtheme@latest my-admin

# Or with npx
npx create-oggtheme my-admin

# Current directory
npx create-oggtheme .

Then:

cd my-admin
npm run dev

Open http://localhost:5173

What's Included

• Full CMS dashboard (Posts, Pages, Media, Users, Analytics, Settings…)
• Complete UI component library (/elements showcase page)
• Cyberpunk glassmorphism design with animated background
• Mock data — ready to swap for real APIs
• AI-ready docs — AGENTS.md, Cursor rules, component reference

CLI Options

Usage: create-oggtheme [project-directory] [options]

Options:
  --help, -h     Show help
  --no-install   Skip npm install after scaffolding

AI / Cursor Support

Every scaffolded project includes:

• AGENTS.md — comprehensive guide for AI assistants (routes, components, patterns)
• .cursor/rules/oggtheme.mdc — Cursor IDE rules loaded automatically
• docs/COMPONENTS.md — UI component API
• docs/ARCHITECTURE.md — architecture overview

These files teach tools like Cursor how to extend the template correctly.

Publish to npm

# 1. Update package.json — set author, repository, homepage
# 2. Login
npm login

# 3. Dry run — check included files
npm pack --dry-run

# 4. Publish
npm publish

See docs/PUBLISHING.md for details.

Package Structure

create-oggtheme/
├── bin/create-oggtheme.js   # CLI scaffold script
├── template/                 # Project template (copied on scaffold)
│   ├── src/
│   ├── AGENTS.md
│   ├── .cursor/rules/
│   ├── docs/
│   └── ...
├── docs/PUBLISHING.md
└── package.json

License

MIT