Ready in 5 minutes ⚡

Get your app up and running in 5 minutes with this step-by-step guide.

Prerequisites

• Node.js 18+ installed
• Git installed
• A code editor (VS Code recommended)

Step 1: Clone & Setup

# Clone the repository
git clone https://github.com/tonrepo/ma-boilerplate.git my-app
cd my-app

# Install dependencies
npm install

# Copy environment file
cp .env.example .env.local

Step 2: Configure Environment

Open .env.local and add your keys:

# Database (Supabase)
SUPABASE_URL=your_supabase_url
SUPABASE_ANON_KEY=your_supabase_anon_key

# Authentication
NEXTAUTH_SECRET=your_secret_key

# Stripe (optional)
STRIPE_SECRET_KEY=your_stripe_secret_key
STRIPE_PUBLISHABLE_KEY=your_stripe_publishable_key

Getting API Keys

• Supabase: Create a project
• Stripe: Get your keys

Step 3: Database Setup

# Run database migrations
npm run db:push

# Seed the database (optional)
npm run db:seed

Step 4: Start Development

# Start the development server
npm run dev

Visit http 😕/localhost:3000 - your app is now running! 🎉

Step 5: Deploy (Optional)

Deploy to Vercel in one click:

Or deploy to Netlify:

What's Next?

• 🔐 Setup User Authentication
• 💳 Configure Stripe Payments
• 📧 Send Transactional Emails
• 🎨 Customize Components

Need Help?

• 📚 Check the documentation
• 🐛 Report issues
• 💬 Join the community