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:
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:
| Tool | Version |
|---|---|
| Bun | 1.1.0 or higher |
| Node.js | 18 or higher (for compatibility) |
Install Bun:
curl -fsSL https://bun.sh/install | bashInstallation
Step 1: Clone the Repository
git clone https://github.com/musayazlik/turbokit.git
cd turbokitStep 2: Install Dependencies
bun installStep 3: Setup Environment
Copy the example environment file and configure your services:
cp .env.example .envUpdate 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:pushStep 5: Start Development Server
bun run devAccess Your Apps
Once the development server is running, you can access:
| Application | URL | Description |
|---|---|---|
| Web | localhost:4100 | Next.js frontend |
| API | localhost:4101 | Elysia.js backend |
| Swagger | localhost:4101/openapi | API documentation |
| Docs | localhost:4100/docs | This 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:studioNote: 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:
- Authentication - Complete auth system with email verification and password reset
- Email Service - Send beautiful emails with Resend and React Email
- Stripe Payments - Accept payments and manage subscriptions with Stripe
- Database Schema - Understand and customize your database models
Optional Services Setup
Email (Resend)
- Sign up at resend.com
- Get your API key from the dashboard
- Add it to your
.envfile asRESEND_API_KEY - Test email sending by registering a new user
Payments (Stripe)
- Sign up at stripe.com
- Get your test API keys from Developers → API Keys
- Add keys to your
.envfile - Install Stripe CLI for webhook testing:
brew install stripe/stripe-cli/stripe
stripe listen --forward-to localhost:4101/webhooks/stripeDatabase (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:16Tip: Start with the authentication flow - register a user, verify email, and explore the admin dashboard.