Quick Start

Welcome to Handyman Services — a production-ready home-repair booking marketplace built with Next.js 16 (App Router), React 19, TypeScript, PostgreSQL and Tailwind CSS. This page gets you from a fresh download to a running site in about 15 minutes.

Handyman Services ships as a vertical pack product: the engine is generic, and a pack supplies the vocabulary, fields, filters, master data and demo content for one business. The pack included is Handyman Services — pros publish plumbing, electrical, carpentry and repair services with weekly availability, and homeowners book a slot and pay. Switching the pack changes every noun on the site (service → consultation, pro → practitioner, homeowner → patient) without touching engine code.

New here? Read Product Overview for the big picture, then come back to install.

What you need

Node.js 20+ and npm
A PostgreSQL database (we recommend Neon — Handyman Services uses the @neondatabase/serverless driver)
About 15 minutes

Install in 4 steps

Terminal

# 1. Install dependencies
npm install

# 2. Create your environment file
#    Create .env.local with at least DATABASE_URL (JWT_SECRET / SECRET_KEY
#    are auto-generated by the install wizard's database step if unset).

# 3. Initialise the database (schema + seed)
npm run db:init

# 4. Start the dev server
npm run dev

Open http://localhost:3000. The first run launches the install wizard at /install — it walks you through the database check, admin account, and store settings.

Load the demo

Terminal

# Apply the vertical pack: master data, categories, fields, filters, copy
npx tsx scripts/apply-vertical.ts handyman-services --yes

# Seed demo providers, services, slots, bookings and reviews.
# Imagery comes from Pexels — set PEXELS_API_KEY in .env for real photos,
# otherwise deterministic placeholders are used.
npm run vertical:demo

# Subscription plans for the demo hosts (cascades off hosts, so re-run after a re-seed)
npx tsx scripts/seed-plans.ts --hosts

# Storefront pages (privacy, cookies, terms, refunds, about)
npx tsx scripts/seed-site-pages.ts

# Account emails, plus booking/waitlist templates for Email, WhatsApp, SMS and Push
npx tsx scripts/seed-message-templates.ts
npx tsx scripts/seed-notification-templates.ts

Demo logins — password Password@1:

Role	Email
Pro (host)	`host1@handymandemo.com` … `host5@handymandemo.com`
Homeowner (customer)	`guest1@handymandemo.com` … `guest5@handymandemo.com`

The two booking mechanics

Mode	How availability works	Used by
`seat`	The host publishes dated sittings (`experience_sessions`) with a place count.	Classes, tours, events
`slot`	The host sets weekly hours (`availability_rules`); slots are expanded on read and only become a row when booked.	Handyman Services, appointment businesses — clinics, salons, tutors

The active pack declares which one it uses; the booking engine, calendar and checkout follow. Handyman Services runs in slot mode.

What the Handyman Services pack gives you

Nine categories — Plumbing Repair, Electrical Work, Painting, Appliance Repair, HVAC Service, General Handyman, Furniture Assembly, Locksmith Services and Drywall Repair — plus eight of its own master tables on top of the shared ones: service_type, booking_type, property_type, job_setting, focus, service_practice, amenities and certification. Booking runs on the slot engine — pros set weekly availability for repairs, installs and maintenance and homeowners book an open slot, the same mechanism clinics and salons use. All master tables are admin-editable under Master Data, and they drive the listing editor, the browse facets and the pro's profile.

Notifications

Four channels, all template-driven from Settings → Notifications and all silent until their provider is connected under Settings → Channels:

Channel	Transport	Fired on
Email	Configured email add-on, SMTP fallback	Booking, reminder, cancellation, payment, waitlist
WhatsApp	Connected WhatsApp add-on	Booking, reminder, cancellation, payment, waitlist
SMS	Connected SMS add-on	Booking, reminder, cancellation, payment, waitlist
Push	Firebase Cloud Messaging → the mobile app	Booking, cancellation, waitlist

Push additionally needs a Firebase service account under Settings → Push. The mobile app registers each device with POST /api/v1/customer/fcm/token; tokens are pruned automatically when FCM reports them unregistered, and every send respects the homeowner's notify_push preference.

Core environment variables

Variable	Purpose
`DATABASE_URL`	PostgreSQL connection string
`JWT_SECRET`	Signs admin/customer session tokens
`SECRET_KEY`	AES-256-GCM key that encrypts stored integration secrets
`PEXELS_API_KEY`	Optional — real demo imagery instead of placeholders
`LICENSE_SERVER_URL`	License server (defaults to `https://creative-cape.com`)

See the Installation Guide for the full list and the License Guide for activation.

Where to go next

Installation Guide — detailed setup
Deployment Guide — ship to production
Admin Guide — run your services day-to-day
API Documentation — the REST surface, plus the live reference at /api/docs/v1
Add-on Development Guide — extend Handyman Services
Customization Guide — change the vertical's fields, filters and vocabulary