Skip to content
ShipSaaSShipSaaS Docs

Quick Start

This document will guide you through setting up ShipSaaS.

Prerequisites

Section titled “Prerequisites”

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

Quick Setup

Section titled “Quick Setup”

Clone Your Project

Section titled “Clone Your Project”

Clone the template repository from GitHub:

Terminal window
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.

Terminal window
# 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

Section titled “Install Project Dependencies”

Install the project dependencies by running:

Terminal window
bun install

Set Environment Variables

Section titled “Set Environment Variables”

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

Terminal window
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

Section titled “Start the Development Server”

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

Terminal window
bun run dev

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

Next Steps

Section titled “Next Steps”

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