Clone the repository

Learn how to clone the MakerKit repository

If you have bought a license for MakerKit, you have access to all the repositories built by the MakerKit team. In this document, we will learn how to fetch and install the codebase.

Requirements

To get started with the Next.js and Firebase SaaS template, we need to ensure you install the required software.

  • Node.js (LTS recommended)
  • Git
  • Docker (optional but highly recommended)

Cloning the repository

You have two choices for cloning the repository: forking the original repository or cloning it. You can fork it from GitHub and then clone it on your local machine, or you can clone it directly.

To get the codebase on your local machine, clone the repository with the following command:

git clone --depth=1 git@github.com:makerkit/next-firebase-saas-kit.git

The command above clones the repository in the folder my-saas which you can rename it with the name of your project.

Initializing Git

Now, run the following commands for:

  1. Moving into the folder
  2. Reinitialize your git repository
  3. Adding the original Makerkit repository as "upstream" so we can fetch updates from the main repository:
cd my-saas rm -rf .git git init git remote add upstream git@github.com:makerkit/next-firebase-saas-kit.git git add . git commit -a -m "Initial Commit"

In this way, to fetch updates (after committing your files), simply run:

git pull upstream main --allow-unrelated-histories

You'll likely run into conflicts when running this command, so carefully choose the changes (sorry!).

Installing the Node dependencies

Finally, we can install the NodeJS dependencies with npm:

npm i

While the application code is fully working, we now need to set up your Firebase project.

So let's jump on to the next step!


Subscribe to our Newsletter
Get the latest updates about React, Remix, Next.js, Firebase, Supabase and Tailwind CSS