Guide
Learn how to use and configure Chameleon AI SaaS features
User Guide
Welcome to the Chameleon User Guide. This section covers everything you need to know about using and configuring Chameleon.
What is Chameleon?
Chameleon is a powerful Next.js AI SaaS boilerplate that provides rich functionality and components to help you rapidly build modern web applications. Built with the latest technologies, Chameleon offers enterprise-grade features out of the box.
Key Features
- ๐ Fast Setup - Built on Next.js 15 with TypeScript
- ๐จ Modern UI - Uses Tailwind CSS and Shadcn UI
- ๐ i18n Support - Built-in internationalization
- ๐ณ Payment Integration - Stripe & Creem support
- ๐ Authentication - Google & GitHub OAuth
- ๐ค AI Integration - Kling, Seedance, OpenAI, and more
- ๐ Admin Dashboard - Complete user management and analytics
- ๐ฑ Responsive Design - Works perfectly on all devices
Prerequisites
Before you start, make sure you have:
System Requirements
- Node.js 18+ - JavaScript runtime
- pnpm (recommended) or npm - Package manager
- Git - Version control
Recommended versions:
$ node -v
v22.2.0
$ pnpm -v
9.15.0
$ git --version
git version 2.39.3
Cloud Services (Optional)
- Vercel - For hosting
- Vercel Postgres - For database
- Stripe - For payments
- AWS S3 - For file storage
- Google Analytics - For analytics
Quick Start Guide
1. Installation
# Clone the repository
git clone https://github.com/chameleon-nexus/chameleon-saas.git
cd chameleon-saas
# Install dependencies
pnpm install
2. Environment Setup
Copy the example environment file:
cp .env.example .env.development
Configure essential variables:
# Database
DATABASE_URL="postgresql://user:password@host:5432/database"
# Authentication
NEXTAUTH_SECRET="your_secret"
NEXTAUTH_URL="http://localhost:3000"
# Admin emails
ADMIN_EMAILS="your-email@example.com"
# Payment (optional)
STRIPE_SECRET_KEY="sk_test_..."
STRIPE_PUBLISHABLE_KEY="pk_test_..."
# AI APIs (optional, can configure in admin)
OPENAI_API_KEY="sk-..."
KLING_ACCESS_KEY="..."
3. Database Setup
Run migrations to create tables:
pnpm db:push
4. Start Development Server
pnpm dev
Visit http://localhost:3000 to see your application.
Guide Sections
Configuration
- Environment Variables - Complete configuration guide
- Prerequisites - Detailed system requirements
Updates & Support
- Changelog - Version history and updates
- FAQ - Frequently asked questions
- Troubleshooting - Common issues and solutions
Learning Resources
- Video Tutorials - Step-by-step video guides
Next Steps
Tutorials
Learn how to customize and extend Chameleon:
- ๐ Customize Landing Page - Edit homepage
- ๐ ๏ธ Create New Pages - Add custom pages
- ๐จ Create New Components - Build components
- ๐ API Integration - Make API calls
Feature Deep Dives
Explore Chameleon's powerful features:
- ๐ค AI Integration - Text, image, video generation
- ๐ณ Payment System - Stripe & Creem setup
- ๐ฐ Credit System - User credit management
- ๐ฅ Referral Program - Affiliate system
Deployment
Deploy your application to production:
- ๐ Deploy to Vercel - Recommended platform
- โ๏ธ Deploy to Cloudflare - Alternative option
- ๐ณ Deploy with Dokploy - Self-hosted deployment
Getting Help
If you encounter any issues:
- ๐ Check the FAQ for common questions
- ๐ง Visit Troubleshooting for solutions
- ๐ Report bugs on GitHub
- ๐ Review the complete technical documentation
Happy building with Chameleon! ๐