Quick Start (5 min setup)
Get SvelteBolt running locally in under 5 minutes.
Prerequisites
- Node.js 18.0 or later
- Bun (recommended) or npm/pnpm/yarn | Instructions to install Bun
Installation
Option 1: Download ZIP
- Download the SvelteBolt ZIP file using the link provided in your purchase confirmation email
- Extract to your desired directory
- Navigate to the project folder
Option 2: Run npx command
The following command will prompt you to enter your project name and create a new SvelteBolt project in the current directory.
- pnpm
- npm
- bun
- yarn
pnpm dlx sbolt
npx sbolt
bun x sbolt
npx sbolt
This command is protected by a login, so you need to use the same email used during the SvelteBolt purchase.
Environment Setup
-
Copy environment file:
cp .env.example .env
-
Add minimum required API keys:
# Supabase (Required)
PUBLIC_SUPABASE_URL=https://your-project-id.supabase.co
PUBLIC_SUPABASE_ANON_KEY=your-anon-key
SUPABASE_SERVICE_ROLE_SECRET=your-service-role-key
# Stripe
PUBLIC_STRIPE_ENABLED=true # Set to false if not using Stripe
PUBLIC_STRIPE_KEY=pk_test_your-key
STRIPE_SECRET_KEY=sk_test_your-key
STRIPE_WEBHOOK_SECRET=whsec_your-webhook-secret
Installation & Start
- Install dependencies:
- pnpm
- npm
- bun
- yarn
pnpm install
npm install
bun install
yarn install
- Start development server:
- pnpm
- npm
- bun
- yarn
pnpm dev
npm run dev
bun dev
yarn dev
You should now see the app at http://localhost:5173
tip
If you encounter any issues, try the following steps:
- Ensure all environment variables are set correctly in your
.env
file - Check the console for any error messages
warning
Note that the first time you run the app, it may take a few minutes to compile all dependencies and set up the environment. The dependencies will be optimized in the background, so the initial load may be slower than subsequent loads.
Next Steps
- Set up Supabase database
- Configure Stripe payments
- Add OAuth providers for social login
- Explore the [project structure](/Getting Started/project-structure)