Skip to content

CodeGuide-dev/codeguide-starter-lite

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

18 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

CodeGuide

CodeGuide Starter Kit Lite

A comprehensive web application framework built with Next.js 15, featuring full-stack development tools, AI integration, and production-ready infrastructure.

Tech Stack

Frontend

Backend & Database

AI & APIs

  • AI Integration: Vercel AI SDK
  • Language Models: OpenAI GPT-4, Anthropic Claude
  • Rate Limiting: Advanced rate limiting with Redis

Infrastructure

  • Containerization: Docker with Docker Compose
  • CI/CD: GitHub Actions
  • Production Deploy: Vercel/AWS with monitoring

Prerequisites

Before you begin, ensure you have the following:

  • Node.js 18+ installed
  • Docker and Docker Compose for development environment
  • A Clerk account for authentication
  • A Supabase account for database
  • Redis instance (local or cloud)
  • AWS account for S3 storage
  • OpenAI API key for AI features
  • Generated project documents from CodeGuide for best development experience

Getting Started

Quick Start (Docker)

  1. Clone the repository

    git clone <repository-url>
    cd codeguide-starter-kit-lite-v2
  2. Environment setup

    cp .env.example .env.local
    # Edit .env.local with your API keys and configuration
  3. Start with Docker

    npm run docker:dev
  4. Install frontend dependencies and start Next.js

    npm install
    npm run dev
  5. Open http://localhost:3000

Manual Setup

  1. Clone and install

    git clone <repository-url>
    cd codeguide-starter-kit-lite-v2
    npm install
  2. Set up services (PostgreSQL, Redis, S3)

    • See Configuration section below for detailed setup
  3. Environment variables

    cp .env.example .env.local
    # Fill in all required environment variables
  4. Database setup

    # Run migrations (when database is connected)
    npm run db:migrate
  5. Start development

    npm run dev

The homepage includes a comprehensive setup dashboard showing the status of all services.

Configuration

Clerk Setup

  1. Go to Clerk Dashboard
  2. Create a new application
  3. Go to API Keys
  4. Copy the NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY and CLERK_SECRET_KEY

Supabase Setup

  1. Go to Supabase Dashboard
  2. Create a new project
  3. Go to Authentication β†’ Integrations β†’ Add Clerk (for third-party auth)
  4. Go to Project Settings > API
  5. Copy the Project URL as NEXT_PUBLIC_SUPABASE_URL
  6. Copy the anon public key as NEXT_PUBLIC_SUPABASE_ANON_KEY

AI Integration Setup (Optional)

  1. Go to OpenAI Platform or Anthropic Console
  2. Create an API key
  3. Add to your environment variables

Environment Variables

Create a .env.local file in the root directory with the following variables:

# Clerk Authentication
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=your_publishable_key
CLERK_SECRET_KEY=your_secret_key

# Supabase
NEXT_PUBLIC_SUPABASE_URL=your_supabase_url
NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key

# AI Integration (Optional)
OPENAI_API_KEY=your_openai_api_key
ANTHROPIC_API_KEY=your_anthropic_api_key

Features

  • πŸ” Authentication with Clerk (middleware protection)
  • πŸ—„οΈ Supabase Database with third-party auth integration
  • πŸ€– AI Chat Interface with OpenAI/Anthropic support
  • 🎨 40+ shadcn/ui components (New York style)
  • πŸŒ™ Dark mode with system preference detection
  • 🎯 Built-in setup dashboard with service status
  • πŸš€ App Router with Server Components
  • πŸ”’ Row Level Security examples with Clerk user IDs
  • πŸ“± Responsive design with TailwindCSS v4
  • 🎨 Custom fonts (Geist Sans, Geist Mono, Parkinsans)

Project Structure

codeguide-starter-kit/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ app/                    # Next.js app router pages
β”‚   β”‚   β”œβ”€β”€ api/chat/          # AI chat API endpoint
β”‚   β”‚   β”œβ”€β”€ globals.css        # Global styles with dark mode
β”‚   β”‚   β”œβ”€β”€ layout.tsx         # Root layout with providers
β”‚   β”‚   └── page.tsx           # Hero + setup dashboard
β”‚   β”œβ”€β”€ components/            # React components
β”‚   β”‚   β”œβ”€β”€ ui/                # shadcn/ui components (40+)
β”‚   β”‚   β”œβ”€β”€ chat.tsx           # AI chat interface
β”‚   β”‚   β”œβ”€β”€ theme-provider.tsx # Theme context
β”‚   β”‚   └── theme-toggle.tsx   # Dark mode toggle
β”‚   β”œβ”€β”€ lib/                   # Utility functions
β”‚   β”‚   β”œβ”€β”€ supabase.ts        # Supabase client with Clerk auth
β”‚   β”‚   β”œβ”€β”€ user.ts            # User utilities
β”‚   β”‚   β”œβ”€β”€ utils.ts           # General utilities
β”‚   β”‚   └── env-check.ts       # Environment validation
β”‚   └── middleware.ts          # Clerk route protection
β”œβ”€β”€ supabase/
β”‚   └── migrations/            # Database migrations with RLS examples
β”œβ”€β”€ CLAUDE.md                  # AI coding agent documentation
β”œβ”€β”€ SUPABASE_CLERK_SETUP.md   # Integration setup guide
└── components.json            # shadcn/ui configuration

Database Integration

This starter includes modern Clerk + Supabase integration:

  • Third-party auth (not deprecated JWT templates)
  • Row Level Security policies using auth.jwt() ->> 'sub' for Clerk user IDs
  • Example migrations with various RLS patterns (user-owned, public/private, collaboration)
  • Server-side client with automatic Clerk token handling

AI Coding Agent Integration

This starter is optimized for AI coding agents:

  • CLAUDE.md - Comprehensive project context and patterns
  • Setup guides with detailed integration steps
  • Example migrations with RLS policy templates
  • Clear file structure and naming conventions
  • TypeScript integration with proper type definitions

Documentation Setup

To implement the generated documentation from CodeGuide:

  1. Create a documentation folder in the root directory:

    mkdir documentation
  2. Place all generated markdown files from CodeGuide in this directory:

    # Example structure
    documentation/
    β”œβ”€β”€ project_requirements_document.md             
    β”œβ”€β”€ app_flow_document.md
    β”œβ”€β”€ frontend_guideline_document.md
    └── backend_structure_document.md
  3. These documentation files will be automatically tracked by git and can be used as a reference for your project's features and implementation details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published