new-hl-project
v1.0.0
Published
Scaffold a new Hikmah Labs project with Convex, Next.js, TypeScript, HeroUI, and more.
Downloads
102
Maintainers
Readme
new-hl-project
A CLI tool to scaffold new Hikmah Labs projects in seconds.
Stack
Every project comes with:
- Next.js (latest, App Router, TypeScript)
- Convex (backend, real-time database)
- Convex Auth (email/password authentication)
- HeroUI (UI component library)
- Tailwind CSS (utility-first styling)
- Phosphor Icons (icon library)
- Bun (runtime & package manager)
- ESLint + Prettier (code quality)
- SEO (sitemap, robots.txt, OG image generation)
Optional add-ons (chosen during setup):
- Stripe — Checkout, webhooks, customer portal
- Loops.so — Transactional & marketing emails
- Dark Mode — Light + dark theme toggle
Usage
Quick start (no install needed)
bunx new-hl-projectOr with npm/npx:
npx new-hl-projectInstall globally
bun add -g new-hl-project
# Then use anywhere:
new-hl-projectWhat you get
my-app/
├── convex/ # Backend: schema, auth, queries
├── public/ # Static assets
├── src/
│ ├── app/ # Pages & routes
│ │ ├── (auth)/ # Sign in, sign up
│ │ ├── (dashboard)/ # Protected app pages
│ │ └── api/ # API routes (OG image, webhooks)
│ ├── components/ # Shared components
│ ├── config/ # appConfig, theme, fonts
│ └── lib/ # Utilities
├── .env.example # All required env vars
├── tailwind.config.ts # Themed + HeroUI plugin
└── README.md # Project-specific docsThe key design principle: appConfig.ts is the single source of truth. Your project name, description, URLs, and brand colors are defined once and referenced everywhere.
Updating the template
This is designed as a living project. To improve the template:
- Edit files in the
template/directory - Run
bun run buildto rebuild the CLI - Publish with
npm publish
New projects get the latest template automatically.
Development
# Clone the repo
git clone https://github.com/yourusername/new-hl-project.git
cd new-hl-project
# Install CLI dependencies
bun install
# Test locally
bun run devLicense
MIT
