Skip to content

Quickstart

Get a local dev server running with a sample event in under 5 minutes.

Prerequisites

  • Node.js 20+ and npm
  • Git

Step 1: Clone and install

bash
git clone https://github.com/loidolt/tripplan-ing.git
cd tripplan-ing
npm install

This installs all workspace dependencies including the event site app, shared packages, and docs.

Step 2: Set up the local database

bash
npm run db:migrate:local

This creates a local SQLite database and applies all migrations. The Node runtime automatically seeds demo data on first run.

Step 3: Start the dev server

bash
make dev

The server starts at http://localhost:5173. It serves both:

  • Event sites — resolved by hostname (localhost falls back to the first available event)
  • Platform UI — at /platform for managing events, organizations, and users

Dev bypass

When running locally with ENABLE_DEV_BYPASS=true in your .dev.vars, the server skips authentication and grants admin access automatically. This avoids needing Mailgun credentials for OTP emails during development.

Step 4: Explore the app

URLWhat you'll see
http://localhost:5173Event homepage with sample content
http://localhost:5173/scheduleMulti-day schedule view
http://localhost:5173/rsvpRSVP form with attendee types
http://localhost:5173/payPayment page (needs Stripe keys)
http://localhost:5173/adminAdmin dashboard
http://localhost:5173/platformPlatform management UI

Step 5: Run quality checks

Before making changes, verify everything passes:

bash
npm run check     # TypeScript + Svelte type checking
npm test          # Unit and integration tests

What's next

Released under the MIT License.