Installation

This guide will walk you through setting up the Nuxt SaaS Kit. We'll cover the entire process, including cloning the project, installing dependencies, setting up the database, and running the development server.

Step 1: Clone the repository

• Open your terminal.
• Navigate to the directory where you want to store the project.
• Run the following command:

$ git clone https://github.com/okikelabs/nuxt-saas-kit.git

Step 2: Configure Environment Variables

• Move into the project

$ cd nuxt-saas-kit

• Copy the .env.example file to .env:

$ cp .env.example .env

Here's a list of the environment variables you need to set up for your project:

Name	Description
NUXT_PUBLIC_SITE_URL	The public URL of your Nuxt application
DATABASE_URL	Connection string for your database
SUPABASE_URL	The URL of your Supabase project
SUPABASE_KEY	The key for your Supabase project
LEMONSQUEEZY_API_KEY	API key for LemonSqueezy integration
LEMONSQUEEZY_SIGNING_SECRET	Signing secret for verifying LemonSqueezy webhooks
LEMONSQUEEZY_STORE_ID	Your LemonSqueezy store ID
LEMONSQUEEZY_STORE_URL	The URL of your LemonSqueezy store
EMAIL_SENDER_ADDRESS	Email address used as the sender for outgoing emails
POSTMARK_API_KEY	API key for Postmark email service (if used)
RESEND_API_KEY	API key for Resend email service (if used)
SENDGRID_API_KEY	API key for SendGrid email service (if used)
CRISP_WEBSITE_ID	Your Crisp Website ID for customer support chat integration

Step 3: Install Dependencies

npm

$ npm install

pnpm

$ pnpm install

yarn

$ yarn install

Step 4: Run the Development Server

• Start the development server:

npm

$ npm run dev

pnpm

$ pnpm dev

yarn

$ yarn dev

• Open your browser and navigate to http://localhost:3000 to see your Nuxt SaaS Kit in action.