Quick Start Guide

Quick Start Guide

Get ThriveSend B2B2G up and running in 10 minutes

---

Prerequisites

Before you begin, ensure you have:

• Node.js 20+ installed
• PostgreSQL 16+ database
• Redis 7+ (optional, for caching)
• Git installed

---

Installation Steps

1. Clone the Repository

git clone https://github.com/gedeza/thrive-send-b2b2g.git
cd thrive-send-b2b2g

2. Install Dependencies

# Using pnpm (recommended)
pnpm install

# Or using npm
npm install

3. Set Up Environment Variables

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

# Edit .env.local with your configuration

Required Environment Variables:

# Database
DATABASE_URL="postgresql://user:password@localhost:5432/thrivesend"

# Clerk Authentication
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY="pk_test_..."
CLERK_SECRET_KEY="sk_test_..."

# App URLs
NEXT_PUBLIC_APP_URL="http://localhost:3000"

4. Set Up Database

# Run Prisma migrations
pnpm prisma migrate dev

# Seed database with sample data (optional)
pnpm prisma db seed

5. Start Development Server

# Start the development server
pnpm dev

# Open browser to http://localhost:3000

---

First Steps

1. Create Your Account

1. Navigate to http://localhost:3000
2. Click “Sign Up”
3. Complete registration
4. Verify your email

2. Set Up Your Organization

1. After login, you’ll be prompted to create an organization
2. Enter your organization details:
   • Organization name
   • Industry sector
   • Contact information

3. Invite Team Members

1. Go to Team section
2. Click “Invite Member”
3. Enter email and select role
4. Team member receives invitation email

4. Add Your First Client

1. Navigate to Clients section
2. Click “Add Client”
3. Enter client details:
   • Client name
   • Sector (Business or Government)
   • Contact information
   • Security clearance (for government clients)

5. Create Your First Campaign

1. Go to Campaigns section
2. Click “Create Campaign”
3. Fill in campaign details:
   • Campaign name
   • Client selection
   • Campaign type
   • Content and approval workflow

---

Next Steps

Now that you’re set up, explore these features:

• Compliance Tools - POPIA compliance features

---

Common Issues

Database Connection Errors

Problem: Cannot connect to PostgreSQL database

Solution:

# Check PostgreSQL is running
pg_isready

# Verify DATABASE_URL in .env.local
# Ensure database exists
createdb thrivesend

Clerk Authentication Errors

Problem: Authentication not working

Solution:

1. Verify Clerk keys in .env.local
2. Check Clerk dashboard for application status
3. Ensure redirect URLs are configured correctly

Port Already in Use

Problem: Port 3000 is already in use

Solution:

# Run on different port
PORT=3001 pnpm dev

---

Getting Help

• GitHub Issues: Report bugs or request features

---

Congratulations! You’re now ready to use ThriveSend B2B2G.