TurboKit

Quickstart

Get TurboKit up and running in 5 minutes

Quickstart

Get your TurboKit project running locally in just a few steps.

Quick Deploy

Deploy to production instantly with Vercel:

Deploy with Vercel

Tip: One-click deploy creates a copy of TurboKit in your GitHub account and deploys the frontend to Vercel automatically.

Prerequisites

Before you begin, make sure you have the following installed:

ToolVersion
Bun1.1.0 or higher
Node.js18 or higher (for compatibility)

Install Bun:

curl -fsSL https://bun.sh/install | bash

Installation

Step 1: Clone the Repository

git clone https://github.com/musayazlik/turbokit.git
cd turbokit

Step 2: Install Dependencies

bun install

Step 3: Setup Environment

Copy the example environment file and configure your services:

cp .env.example .env

Update the following in .env:

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

# JWT & Session
JWT_SECRET="your-super-secret-jwt-key-change-in-production"
SESSION_SECRET="another-super-secret-key"

# Email (Resend) - Get your key from resend.com
RESEND_API_KEY="re_your_api_key_here"
FROM_EMAIL="noreply@yourdomain.com"

# Stripe (Optional) - Get your keys from stripe.com
STRIPE_SECRET_KEY="sk_test_your_secret_key"
STRIPE_PUBLISHABLE_KEY="pk_test_your_publishable_key"
STRIPE_WEBHOOK_SECRET="whsec_your_webhook_secret"

# App Configuration
APP_NAME="TurboKit"
FRONTEND_URL="http://localhost:4100"
NEXT_PUBLIC_API_URL="http://localhost:4101"
NODE_ENV="development"

Step 4: Setup Database

Push the Prisma schema to your database:

bun run db:push

Step 5: Start Development Server

bun run dev

Access Your Apps

Once the development server is running, you can access:

ApplicationURLDescription
Weblocalhost:4100Next.js frontend
APIlocalhost:4101Elysia.js backend
Swaggerlocalhost:4101/openapiAPI documentation
Docslocalhost:4100/docsThis documentation

Useful Commands

# Run all apps in development mode
bun run dev

# Build all packages
bun run build

# Type check all packages
bun run check-types

# Open Prisma Studio
bun run db:studio

Note: The first time you run bun run dev, it may take a few seconds to install dependencies and start all services.

Next Steps

Now that your project is running, explore these features:

Optional Services Setup

Email (Resend)

  1. Sign up at resend.com
  2. Get your API key from the dashboard
  3. Add it to your .env file as RESEND_API_KEY
  4. Test email sending by registering a new user

Payments (Stripe)

  1. Sign up at stripe.com
  2. Get your test API keys from Developers → API Keys
  3. Add keys to your .env file
  4. Install Stripe CLI for webhook testing:
brew install stripe/stripe-cli/stripe
stripe listen --forward-to localhost:4101/webhooks/stripe

Database (PostgreSQL)

For local development, you can use Docker:

docker run -d \
  --name turbokit-postgres \
  -e POSTGRES_PASSWORD=postgres \
  -e POSTGRES_DB=turbokit \
  -p 5432:5432 \
  postgres:16

Tip: Start with the authentication flow - register a user, verify email, and explore the admin dashboard.

On this page