Get Started

Welcome to ShipAhead! This guide makes it easy to set up your SaaS boilerplate. Follow these steps and get your app running in 5 minutes!

Prerequisites

Ensure the following are installed:

• Node.js: Version 22.x or higher (includes npm for package management).
• Git: For version control and cloning the repository.
• Cursor or VSCode: For editing the code.

Setup in 5 Minutes

1. Clone the Repository (Few ways)

   1. Fork it on GitHub and clone your fork
      terminal

      git clone https://github.com/your-username/shipahead-template.git your-project-name

   2. Use Template
      • Click Use this template on ShipAhead repo, then will create a new repository and clone it to your account
   3. Direct Clone
      terminal

      git clone https://github.com/Tom-Han-Org/shipahead-template.git your-project-name
      cd your-project-name

2. Install Dependencies
   Run the following command to install all required packages:

   terminal

   npm install

3. Configure Your Project

   • Environment Variables:
     Copy the example environment file and update it with your settings (e.g., API keys, database URLs):
     terminal

     mv .env.example .env.local

     Open .env.local in a text editor and fill in the necessary values.
   • App Configuration:
     Edit shared/config.js to customize settings like your app name or feature toggles.

4. Run the Development Server
   Start the local server to preview your app:

   terminal

   npm run dev

   Your app will be live at (http://localhost:3000). 🎉

Pull Updates

To keep your project updated with the latest ShipAhead features and fixes:

git remote add upstream https://github.com/Tom-Han-Org/shipahead-template.git
git fetch upstream
git merge upstream/main

Note: If you face merge conflicts, resolve them manually by reviewing the conflicting files