Installation

Get started with the boilerplate in just a few minutes.

System Requirements

• Node.js 18+ (LTS recommended)
• npm 9+ or yarn 3+
• Git for version control

Quick Installation

1. Clone the Repository

git clone https://github.com/mhdevfr/clawplate.git my-boilerplate
cd my-boilerplate

2. Install Dependencies

npm

npm install

yarn

yarn install

pnpm

pnpm install

3. Environment Setup

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

Edit .env.local with your configuration:

# Database
DATABASE_URL="your_database_url"

# Authentication
NEXTAUTH_SECRET="your-secret-key"
NEXTAUTH_URL="http://localhost:3000"

# Supabase
NEXT_PUBLIC_SUPABASE_URL="your_supabase_url"
NEXT_PUBLIC_SUPABASE_ANON_KEY="your_supabase_anon_key"

# Stripe (optional)
STRIPE_SECRET_KEY="sk_test_..."
NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY="pk_test_..."

4. Database Setup

# Initialize database
npm run db:push

# Seed with sample data (optional)
npm run db:seed

5. Start Development

npm run dev

Your app will be available at localhost:3000 ✨

Verification

Check if everything is working:

1. Homepage loads - Visit http 😕/localhost:3000
2. Database connected - Check the logs for connection success
3. Authentication works - Try signing up/in
4. Styles loaded - Tailwind CSS should be active

Troubleshooting

Common Issues

Port 3000 already in use

# Use a different port
npm run dev -- --port 3001

Database connection failed

• Verify your DATABASE_URL in .env.local
• Check if your database service is running

Module not found errors

# Clear node modules and reinstall
rm -rf node_modules package-lock.json
npm install

Build errors

# Clear Next.js cache
rm -rf .next
npm run dev

Getting Help

• 📖 Check the tutorials
• 🐛 Report a bug
• 💬 Ask questions

Next Steps

Now that you have the boilerplate installed:

1. 🚀 Complete the 5-minute setup
2. 🔐 Configure authentication in the Features section
3. 🎨 Explore the components
4. 📧 Setup email delivery