Getting Started

Prerequisite

All you need to have installed on your machine is Bun.

• Bun (v1.0 or higher)

Setup Instructions

Follow these steps to get your project running locally.

1. Unzip the Project After purchasing and downloading the project from Creem, unzip the SaaSKit.zip file. Then, open up your terminal and navigate into the project folder.

# Example:
cd saaskit

2. Install Dependencies This will install all the necessary packages for the project using Bun.

bun install

3. Set Up Environment Variables You need to create a .env file to store your secrets. You can do this by copying the example file.

cp .env.example .env

Now, open the .env file in your editor. This is where you'll add your database connection URL (DATABASE_URL) from your hosting provider and other secrets. If you don't need a specific feature, you can leave its environment variables blank or remove them.

4. Run Database Migrations This command connects to your remote database and syncs it with the Drizzle schema defined in the project.

bun db:push

5. Run the Development Server

bun dev

And you're live! 🚀 Open your browser to http://localhost:5173 to see your new SaaSKit project in action.

What's Next?

Now that you're set up, here are a few places to start:

• Explore the src/routes directory to see how pages and authentication are structured.
• Customize user roles in the database schema (src/db/schema.ts).
• Begin building your first core feature!