create-kofi-stack 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 theodenanyoh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,296 @@
+<p align="center">
+  <br />
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/theodenanyoh11/create-kofi-stack/main/.github/assets/logo-dark.svg">
+    <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/theodenanyoh11/create-kofi-stack/main/.github/assets/logo-light.svg">
+    <img alt="create-kofi-stack" src="https://raw.githubusercontent.com/theodenanyoh11/create-kofi-stack/main/.github/assets/logo-light.svg" width="400">
+  </picture>
+  <br />
+</p>
+
+<h3 align="center">
+  Scaffold opinionated full-stack projects with ease
+</h3>
+
+<p align="center">
+  Next.js 16 + Convex + Better-Auth + shadcn/ui v4 + Tailwind CSS v4
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/create-kofi-stack"><img src="https://img.shields.io/npm/v/create-kofi-stack.svg?style=flat&colorA=18181b&colorB=28cf8d" alt="npm version" /></a>
+  <a href="https://www.npmjs.com/package/create-kofi-stack"><img src="https://img.shields.io/npm/dm/create-kofi-stack.svg?style=flat&colorA=18181b&colorB=28cf8d" alt="npm downloads" /></a>
+  <a href="https://github.com/theodenanyoh11/create-kofi-stack/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/create-kofi-stack.svg?style=flat&colorA=18181b&colorB=28cf8d" alt="license" /></a>
+</p>
+
+<p align="center">
+  <a href="#quick-start">Quick Start</a> •
+  <a href="#whats-included">What's Included</a> •
+  <a href="#cli-options">CLI Options</a> •
+  <a href="#contributing">Contributing</a>
+</p>
+
+---
+
+## Philosophy
+
+- **Opinionated but Flexible** — Sensible defaults with room to customize
+- **Modern Stack** — Latest versions of Next.js 16, Tailwind v4, and shadcn/ui v4
+- **Real-time First** — Convex for instant data sync out of the box
+- **Production Ready** — Auth, email, testing, and linting pre-configured
+
+## Quick Start
+
+```bash
+# Using pnpm (recommended)
+pnpm create kofi-stack my-app
+
+# Using npx
+npx create-kofi-stack my-app
+
+# Using bun
+bunx create-kofi-stack my-app
+```
+
+Or with specific options:
+
+```bash
+npx create-kofi-stack my-app --monorepo --marketing=payload --docs --analytics=posthog
+```
+
+## What's Included
+
+### Always Included (Zero Config)
+
+| Category | Technology |
+|----------|------------|
+| **Framework** | [Next.js 16](https://nextjs.org) with App Router & TypeScript |
+| **Database** | [Convex](https://convex.dev) — Real-time database with Better-Auth integration |
+| **Auth** | [Better-Auth](https://better-auth.com) — Email/password + Google OAuth |
+| **Styling** | [Tailwind CSS v4](https://tailwindcss.com) + [shadcn/ui v4](https://ui.shadcn.com) |
+| **Linting** | [Biome](https://biomejs.dev) — Fast linting and formatting |
+| **Git Hooks** | [Husky](https://typicode.github.io/husky) + lint-staged |
+| **Testing** | [Vitest](https://vitest.dev) + [Playwright](https://playwright.dev) |
+| **Email** | [Resend](https://resend.com) + [React Email](https://react.email) |
+
+### Optional Features
+
+<details>
+<summary><strong>Project Structure</strong></summary>
+
+Choose between a simple single app or a full monorepo setup:
+
+- **Single App** — Simple, single Next.js application
+- **Monorepo** — Turborepo with apps (`web`, `marketing`, `docs`) and shared packages (`ui`, `backend`, `config`)
+
+</details>
+
+<details>
+<summary><strong>shadcn/ui v4 Customization</strong></summary>
+
+Full support for shadcn/ui v4's new style system:
+
+- **Component Library** — Base UI or Radix UI
+- **Style Variants** — Nova, Vega, Maia, Lyra, Mira
+- **Base Colors** — Neutral, Gray, Zinc, Stone, Slate
+- **Theme Colors** — Blue, Green, Orange, Red, Violet, Yellow
+- **Icon Libraries** — Lucide, HugeIcons, Tabler, Phosphor
+
+</details>
+
+<details>
+<summary><strong>Marketing Site</strong> (Monorepo only)</summary>
+
+Add a marketing site to your monorepo:
+
+- **Payload CMS** — Headless CMS with Supabase Postgres
+- **Next.js** — Simple static/SSG marketing site
+- **Astro** — Lightweight, content-focused site
+
+</details>
+
+<details>
+<summary><strong>Documentation</strong></summary>
+
+- **Fumadocs** — Beautiful, fast documentation site
+
+</details>
+
+<details>
+<summary><strong>Authentication Providers</strong></summary>
+
+Add additional OAuth providers:
+
+- GitHub, Discord, Twitter/X, Apple, Microsoft, LinkedIn
+- Organizations/multi-tenancy support
+
+</details>
+
+<details>
+<summary><strong>Integrations</strong></summary>
+
+| Category | Options |
+|----------|---------|
+| **Analytics** | PostHog, Vercel Analytics |
+| **File Uploads** | Uploadthing, AWS S3, Vercel Blob |
+| **Rate Limiting** | Arcjet, Upstash |
+| **Error Monitoring** | Sentry |
+
+</details>
+
+## CLI Options
+
+```bash
+npx create-kofi-stack [project-name] [options]
+```
+
+| Option | Description |
+|--------|-------------|
+| `--monorepo` | Use monorepo structure with Turborepo |
+| `--single` | Use single app structure |
+| `--marketing <type>` | Marketing site: `payload`, `nextjs`, `astro`, `none` |
+| `--docs` | Include documentation site (Fumadocs) |
+| `--component-library <lib>` | Component library: `base`, `radix` |
+| `--style <style>` | Style variant: `nova`, `vega`, `maia`, `lyra`, `mira` |
+| `--base-color <color>` | Base color: `neutral`, `gray`, `zinc`, `stone`, `slate` |
+| `--theme-color <color>` | Theme color: `blue`, `green`, `orange`, `red`, `violet`, `yellow` |
+| `--icon-library <lib>` | Icons: `lucide`, `hugeicons`, `tabler`, `phosphor` |
+| `--auth-providers <list>` | Auth providers (comma-separated) |
+| `--organizations` | Enable multi-tenancy |
+| `--analytics <provider>` | Analytics: `posthog`, `vercel`, `none` |
+| `--uploads <provider>` | Uploads: `uploadthing`, `s3`, `vercel-blob`, `none` |
+| `--rate-limiting <provider>` | Rate limiting: `arcjet`, `upstash`, `none` |
+| `--monitoring <provider>` | Monitoring: `sentry`, `none` |
+| `-y, --yes` | Skip confirmation prompt |
+
+## Project Structure
+
+<details>
+<summary><strong>Single App</strong></summary>
+
+```
+my-project/
+├── src/
+│   ├── app/              # Next.js App Router
+│   │   ├── (auth)/       # Auth pages (sign-in, sign-up)
+│   │   ├── (dashboard)/  # Protected dashboard pages
+│   │   └── api/          # API routes
+│   ├── components/       # React components
+│   │   ├── auth/         # Auth components
+│   │   └── ui/           # shadcn/ui components
+│   ├── lib/              # Utilities and configs
+│   ├── hooks/            # Custom React hooks
+│   └── emails/           # React Email templates
+├── convex/               # Convex backend
+├── tests/
+│   ├── unit/             # Vitest unit tests
+│   └── e2e/              # Playwright E2E tests
+├── public/
+├── components.json       # shadcn/ui config
+└── package.json
+```
+
+</details>
+
+<details>
+<summary><strong>Monorepo</strong></summary>
+
+```
+my-project/
+├── apps/
+│   ├── web/              # Main Next.js app
+│   ├── marketing/        # Marketing site (optional)
+│   └── docs/             # Documentation site (optional)
+├── packages/
+│   ├── backend/          # Convex backend (shared)
+│   ├── ui/               # Shared UI components
+│   ├── config-biome/     # Shared Biome config
+│   ├── config-typescript/# Shared TypeScript config
+│   └── config-tailwind/  # Shared Tailwind config
+├── turbo.json
+└── pnpm-workspace.yaml
+```
+
+</details>
+
+## Getting Started
+
+After creating your project:
+
+```bash
+cd my-project
+
+# Set up environment variables
+cp .env.example .env.local
+
+# Start Convex dev server (in one terminal)
+pnpm convex dev
+
+# Start the app (in another terminal)
+pnpm dev
+```
+
+## Contributing
+
+We welcome contributions! Here's how you can help:
+
+### Getting Started
+
+1. **Fork the repository** and clone it locally
+2. **Install dependencies** with `pnpm install`
+3. **Create a branch** for your feature or fix
+
+```bash
+git checkout -b feature/my-feature
+# or
+git checkout -b fix/my-fix
+```
+
+### Development
+
+```bash
+# Build the CLI
+pnpm build
+
+# Watch mode during development
+pnpm dev
+
+# Test locally
+node dist/index.js my-test-project --single -y
+```
+
+### Guidelines
+
+- **Code Style** — We use Biome for linting and formatting. Run `pnpm lint` before committing.
+- **Commits** — Write clear, concise commit messages describing your changes.
+- **Tests** — If you're adding a new feature, consider adding tests.
+- **Documentation** — Update the README if you're changing CLI options or behavior.
+
+### Pull Requests
+
+1. Make sure your code builds without errors (`pnpm build`)
+2. Update documentation if needed
+3. Open a PR with a clear description of your changes
+4. Link any related issues
+
+### Reporting Issues
+
+Found a bug or have a feature request? [Open an issue](https://github.com/theodenanyoh11/create-kofi-stack/issues/new) with:
+
+- A clear title and description
+- Steps to reproduce (for bugs)
+- Expected vs actual behavior
+- Your environment (OS, Node version, etc.)
+
+## Documentation
+
+- [Convex Docs](https://docs.convex.dev)
+- [Better-Auth Docs](https://www.better-auth.com)
+- [shadcn/ui Docs](https://ui.shadcn.com)
+- [Payload CMS Docs](https://payloadcms.com/docs)
+- [Fumadocs](https://fumadocs.vercel.app)
+- [Next.js Docs](https://nextjs.org/docs)
+- [Tailwind CSS Docs](https://tailwindcss.com/docs)
+
+## License
+
+MIT © [theodenanyoh](https://github.com/theodenanyoh11)

package/dist/index.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node