Cloning the boilerplate

Cloning the boilerplate

Learn how to clone the boilerplate and set it up on your machine.

In this guide, we will go through the process of setting up a SaaS application using SaaSKit.


Before we start, make sure you have the following installed:

Clone the boilerplate

To get the codebase on your machine, clone the repository using Git:

git clone [email protected]:saas-kits/remix-boilerplate.git

The above command will clone the repository into a directory named remix-boilerplate. You can change the directory name to whatever you want.

Add your own remote

Once you have cloned the repository, you can add your own remote to it:

cd remix-boilerplate
git remote remove origin
git remote add origin <your-git-repo-url>
git remote add upstream [email protected]:saas-kits/remix-boilerplate.git

This will remove the default remote and add your own remote to the repository. You can now push your code to your own remote.

Fetching new changes

If you want to fetch the latest changes from the upstream repository, you can run the following command:

  • Make sure you don't have any uncommitted changes before running the above command.
  • Make sure you run the above command from the root of the repository.
git fetch upstream

This might result in merge conflicts. If it does, you can resolve them manually.

Installing dependencies

Once you have cloned the repository, you can install the dependencies using PNPM:

pnpm install

For application to properly run, we will need to add some environment variables.

Adding environment variables

Copy the .env.example file to .env:

cp .env.example .env

We will need to add the following environment variables:

## Stripe

We will go through each of these environment variables in detail.

Let's start with the Database URL in the next section.