ken-project-starter

Ken Project Starter

Ken Project Starter is a CLI tool to automatically scaffold a modern monorepo using Turborepo, with a Next.js app pre-configured for shadcn/ui, cursor rules, Supabase, Firebase, and Tailwind CSS.

Prerequisites

• Node.js and npm (LTS version recommended, download from nodejs.org).
• Git (download from git-scm.com).
• Internet access for cloning repositories and installing dependencies.

Installation

npm install -g ken-project-starter

Usage

ken-start <your-app-name>

This will:

• Scaffold a Turborepo monorepo in the current directory.
• Create a Next.js app in apps/<your-app-name> with TypeScript, Tailwind CSS, ESLint, shadcn/ui, and src directory structure.
• Clone cursor-rules-guide and copy markdown rules into the Next.js app.
• Install dependencies: @supabase/supabase-js, firebase, shadcn-ui in the Next.js app.
• Initialize a Git repository for the monorepo.
• Create .env.local in the Next.js app for Supabase and Firebase credentials.

Example

ken-start my-next-app

After Setup

To start developing your Next.js app:

cd apps/my-next-app
npm run dev

Environment Variables

Update apps/<your-app-name>/.env.local with your Supabase and Firebase credentials.

License

MIT

• Open nextjs-project-TIMESTAMP/.env.local.
• Replace placeholders with your Supabase and Firebase credentials (from Supabase Dashboard and Firebase Console).

• Start the development server:

  cd nextjs-project-TIMESTAMP
  npm run dev
  

  • The Next.js app runs at http://localhost:3000.

Notes

• The npx create-next-app@latest command uses TypeScript, Tailwind CSS, ESLint, and the App Router for a modern setup.
• The npx shadcn@latest init -y command uses defaults to avoid interactive prompts.
• If cursor-rules-guide is private, configure SSH or use a token in the URL.
• To add specific shadcn/ui components, run npx shadcn@latest add <component> in the project directory.

Troubleshooting

• Command not found: Ensure ken-project-starter is installed globally (npm install -g ken-project-starter).
• Permission errors: Run npm install -g ken-project-starter with sudo if needed, or fix npm permissions.
• Network errors: Check internet connectivity and GitHub repository access.
• Dependency issues: Run npm install in the generated project directory if needed.

Development

To modify or test locally:

• Clone the repository:

  git clone https://github.com/YOUR_USERNAME/ken-project-starter.git
  cd ken-project-starter
  

• Link locally:

  npm link
  

• Test the command:

  ken-start-project
  

License

MIT