Skip to content

QUICK-START.md

Latest commit

 

History

History
71 lines (49 loc) · 1.45 KB

QUICK-START.md

File metadata and controls

71 lines (49 loc) · 1.45 KB

🚀 Quick Usage Guide

5-Minute Setup

1. Install & Run

npm install
npm run dev

2. Try Different Configurations

# Switch to TaskMaster Pro (Productivity App)
npm run config:taskmaster

# Switch to ShopSmart (E-commerce)
npm run config:shopsmart

# Back to default (Cal AI)
npm run config:default

3. Customize Your Own

Edit /src/config/app-config.ts:

export const appConfig = {
  brand: {
    name: 'Your App Name', // 👈 Change this
    logo: '/your-logo.svg', // 👈 Add your logo
    tagline: 'Your tagline', // 👈 Your main message
    // ...
  },
};

4. Add Your Images

  1. Put images in /public/ folder
  2. Update paths in config file
  3. Refresh browser ✨

What You Can Customize

  • ✅ All text content (titles, descriptions, button text)
  • ✅ Brand identity (name, logo, tagline)
  • ✅ Images & mockups (hero devices, features, etc.)
  • ✅ Testimonials (customer quotes, names, photos)
  • ✅ Pricing plans (tiers, features, prices)
  • ✅ Social links (LinkedIn, Twitter, Instagram)
  • ✅ Theme colors (primary brand colors)

File to Edit

📝 Main config: /src/config/app-config.ts

That's it! One file controls everything. 🎯

Examples

See /src/config/example-*.ts files for complete rebranding examples:

  • TaskMaster Pro (productivity)
  • ShopSmart (e-commerce)

Need help? Check the full CONFIGURATION.md guide.