Quick Start

This document will guide you through setting up ShipSaaS.

Prerequisites

Before starting, please confirm if your network and development environments are ready, referencing the Get ShipSaaS document.

Quick Setup

Clone Your Project

Clone the template repository from GitHub:

git clone https://github.com/ShipSaaS/shipsaas-fumadocs.git your-project-name

cd your-project-name

Remove the original template remote link, and create a private GitHub repository.

# Remove the original template remote repository
git remote remove origin

# Create a private repository on GitHub, set as the remote origin
gh repo create your-project-name --private --source=. --remote=origin

# Push code to your new repository, set default branch as main
git push -u origin main

This command will create a private GitHub repository, set it as the origin remote, and push the code.

Install Project Dependencies

Install the project dependencies by running:

bun install

Set Environment Variables

Copy the .env.example file to .env as a starting point.

cp .env.example .env

Open the environment variables file and set the variables to your desired values. You can find more information about environment variables in the Environment Configuration document.

Start the Development Server

Now that you have configured your environment variables, you can start the development server by running:

bun run dev

This will launch the development server at http://localhost:3000, where you can access the template website.

Next Steps

Now that you are running ShipSaaS, here are some subsequent steps:

• Environment Configuration - Configure environment variables

• Website Configuration - Configure core website settings

• Database - Configure database

• Deployment - Deploy to Cloudflare Workers

• Codebase

• Environment Configuration