Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 3 additions & 35 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,22 +1,11 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
node_modules

# testing
coverage

# build
build/
dist/
.turbo
.next
.cache

# misc
.DS_Store
*.pem
*.old

# debug
*.log*
Expand All @@ -25,27 +14,6 @@ dist/
.env.local
.env.test

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts

# old folder dumping grounds
old/
tmp/


# bug - ruler does not include these
/.gemini/
/.qwen/

# START Ruler Generated Files
/.cursor/rules/ruler_cursor_instructions.mdc
/.cursor/rules/ruler_cursor_instructions.mdc.bak
/AGENTS.md
/AGENTS.md.bak
/opencode.json
/opencode.json.bak
# END Ruler Generated Files
# skills lock file (optional - uncomment if you don't want to track)
# skills-lock.json
.turbo/
241 changes: 100 additions & 141 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,186 +1,145 @@
# StartupKit

The startup stack for the AI era.
Startup skills for AI agents.

[**startupkit.com**](https://startupkit.com) | [GitHub](https://github.com/ian/startupkit) | [Documentation](https://startupkit.com)
**startupkit.com** | [GitHub](https://github.com/ian/startupkit)

## What is StartupKit?

StartupKit is a meta-framework for building SaaS applications. Built for founders who move fast, loved by the AI tools that help them. Pre-configured auth, analytics, database, and UI components with clear patterns your copilot can follow.
StartupKit equips your project with a comprehensive set of AI agent skills covering product, engineering, design, and marketing expertise. Works with OpenCode and Claude Code.

One command to start:
One command to initialize:

```bash
npx startupkit init
```

## Why StartupKit?

### AI Needs Constraints to Be Useful

Without structure, every project becomes a different architecture. That's **AI slop**.

| Without StartupKit | With StartupKit |
|-------------------|-----------------|
| Where should auth logic live? | `@repo/auth` → Better Auth, ready |
| Prisma or Drizzle? Which pattern? | `@repo/db` → Drizzle + Postgres, configured |
| App router or pages? RSC or client? | Next.js 16 App Router, RSC by default |
| How do I structure shared code? | Monorepo → share everything |
| Which analytics provider? | `@repo/analytics` → Provider-agnostic hooks |

**Start at 70%.** AI handles the details, not the foundation.
This creates:

### Built for the New Era of Development
- **AGENTS.md** - Project context and agent instructions
- **SOUL.md** - Vision, mission, and values
- Installs all default skills

StartupKit is designed to work seamlessly with AI development tools:
## Why StartupKit?

- ✅ **Devin** ready
- ✅ **Claude** ready
- ✅ **Amp** ready
- ✅ **OpenCode** ready
AI agents are only as good as their instructions. StartupKit provides curated skills that give your agents the expertise of a full startup team:

Every project includes `AGENTS.md` with clear conventions, file placement guidelines, and architecture patterns that AI tools understand.
| Category | Skills Include |
| --------------- | ----------------------------------------------------------------- |
| **Product** | Brainstorming, planning, CRO, A/B testing, growth loops |
| **Engineering** | React/Next.js patterns, debugging, TDD, code review, auth, mobile |
| **Design** | UI/UX patterns, design documentation, website audits |
| **Marketing** | Copywriting, SEO, content strategy, social media, pricing |

## Quick Start

```bash
# Initialize project (creates AGENTS.md, SOUL.md, installs skills)
npx startupkit init
cd my-project
cp .env.example .env.local
pnpm dev
```

Visit [http://localhost:3000](http://localhost:3000)

## What's Included

### 📦 Pre-Built Packages
# Skip prompts, use defaults
npx startupkit init -y

- **`@repo/auth`** - Authentication with Better Auth (Google OAuth, Email OTP)
- **`@repo/analytics`** - Provider-agnostic analytics hooks and context
- **`@repo/db`** - Database with Drizzle ORM + PostgreSQL
- **`@repo/ui`** - 60+ Shadcn components, pre-configured
- **`@repo/emails`** - Email templates with React Email
- **`@repo/utils`** - Common utilities for SaaS applications
# Install globally
npx startupkit init --global

### 🏗️ Monorepo Architecture
# Preview without installing skills
npx startupkit init --skip-skills

- **pnpm workspaces** - Efficient dependency management
- **Turbo** - Fast task orchestration (build, dev, lint)
- **TypeScript** - Strict type checking across all packages
- **Biome** - Fast linting and formatting
# Add skills interactively
npx startupkit skills add

### 🎨 UI & Styling
# Install all skills
npx startupkit skills add --all

- **Shadcn UI** - Beautiful, accessible components
- **Tailwind CSS** - Utility-first styling
- **Lucide Icons** - Clean, consistent icons
# Install specific category
npx startupkit skills add --category engineering

### 🗄️ Database
# Install single skill
npx startupkit skills add brainstorming

- **Drizzle ORM** - Type-safe database access
- **PostgreSQL** - Production-ready database setup
- **Migrations** - Version-controlled schema changes

## Project Structure

```
my-project/
├── apps/
│ └── web/ # Main Next.js application
├── packages/
│ ├── analytics/ # Analytics implementation
│ ├── auth/ # Authentication setup
│ ├── db/ # Database schema & migrations
│ ├── emails/ # Email templates
│ ├── ui/ # Shared UI components
│ └── utils/ # Utility functions
├── config/
│ ├── biome/ # Linter configuration
│ └── typescript/ # TypeScript configs
├── AGENTS.md # AI development guidelines
└── pnpm-workspace.yaml # Workspace definition
# Preview without installing
npx startupkit skills add --all --dry-run
```

## Common Tasks
## Supported Agents

### Development
- ✅ **OpenCode**
- ✅ **Claude Code**

```bash
pnpm dev # Start all apps
pnpm --filter web dev # Start specific app
pnpm build # Build all packages
```

### Database

```bash
pnpm db:generate # Generate migration files
pnpm db:migrate # Apply migrations
pnpm db:studio # Open database GUI
```
Skills are installed to both `.opencode/skills/` and `.claude/skills/` by default.

### UI Components
## Commands

```bash
pnpm shadcn add button
pnpm shadcn add dialog
startupkit init # Initialize project with AGENTS.md, SOUL.md, and skills
startupkit init -y # Skip prompts, use defaults
startupkit init --global # Install skills globally
startupkit init --skip-skills # Skip skill installation
startupkit skills # List available skills
startupkit skills add # Add skills interactively
startupkit skills add --all # Install all skills
startupkit skills add --category product # Install specific category
startupkit skills add brainstorming # Install specific skill
startupkit skills list --installed # List installed skills
startupkit skills remove <skill> # Remove a skill
startupkit skills add --global # Install globally
startupkit skills add --dry-run # Preview without installing
```

### Code Quality

```bash
pnpm lint # Check all files
pnpm lint:fix # Fix issues
pnpm typecheck # Type check all packages
```

## Add New Services

Expand your monorepo with new apps instantly:

- **Next.js** - Full-stack React framework ✅
- **Vite** - Lightning fast frontend tooling ✅
- **Expo** - React Native for mobile (coming soon)

## Environment Setup

Configure your environment variables in `.env.local`:

```bash
# Database
DATABASE_URL=postgresql://user:pass@localhost:5432/mydb

# Authentication
GOOGLE_CLIENT_ID=your_google_client_id
GOOGLE_CLIENT_SECRET=your_google_client_secret

# Analytics (optional)
NEXT_PUBLIC_POSTHOG_KEY=phc_...
NEXT_PUBLIC_POSTHOG_HOST=https://app.posthog.com
```
## Skill Categories

### Product

- `brainstorming` - Ideation techniques
- `writing-plans` - Comprehensive planning
- `executing-plans` - Systematic execution
- `verification-before-completion` - Quality assurance
- `page-cro` - Landing page optimization
- `onboarding-cro` - Onboarding flows
- `ab-test-setup` - A/B testing
- `referral-program` - Referral systems

### Engineering

- `vercel-react-best-practices` - React/Next.js performance
- `vercel-composition-patterns` - Scalable component patterns
- `web-design-guidelines` - Web interface compliance
- `v0-automation` - V0 automation for rapid UI
- `premium-frontend-design` - Premium frontend patterns
- `better-auth-best-practices` - Better Auth patterns
- `building-native-ui` - Native UI with Expo
- `systematic-debugging` - Debug methodology
- `test-driven-development` - TDD practices

### Design

- `design-md` - Design documentation
- `ui-ux-pro-max` - Pro-level UI/UX patterns
- `explainer-video-guide` - Explainer video creation
- `audit-website` - Website audit methodology

### Marketing

- `copywriting` - Persuasive writing
- `marketing-psychology` - Consumer psychology
- `seo-audit` - SEO optimization
- `seo` - SEO best practices
- `seo-geo` - Generative Engine Optimization
- `keyword-research` - Keyword research
- `backlink-analyzer` - Backlink analysis
- `reddit` - Reddit marketing
- `twitter` - Twitter/X marketing
- `producthunt` - Product Hunt launch
- `pricing-strategy` - Pricing models
- `launch-strategy` - Product launches
- `email-sequence` - Email campaigns
- `paid-ads` - Advertising strategies

## Tech Stack

- **Framework:** Next.js 16 (App Router)
- **UI:** React 19 + Shadcn UI + Tailwind CSS
- **Language:** TypeScript (strict mode)
- **Database:** PostgreSQL + Drizzle ORM
- **Auth:** Better Auth
- **Email:** React Email + Resend
- **Monorepo:** pnpm + Turbo
- **Linting:** Biome

## Support & Resources

- **Website:** [startupkit.com](https://startupkit.com)
- **GitHub:** [github.com/ian/startupkit](https://github.com/ian/startupkit)
- **Issues:** [github.com/ian/startupkit/issues](https://github.com/ian/startupkit/issues)
This CLI wraps the [skills.sh](https://skills.sh) ecosystem. Skills are SKILL.md files that work across AI agent platforms.

## License

ISC © 2025 01 Studio

---

**Stop burning tokens. Start shipping faster.** 🚀
Loading