Clone the Git repository

Learn how to clone the Saas UI Git repository.

In case you have redeemed your license key and accepted the Github invite, you should now have access to the Saas UI Pro Git repository.

Clone the repository#

To clone the repository on your local machine, use the following command:

git clone --single-branch --branch=main git@github.com:saas-js/saas-ui-pro-nextjs-starter-kit.git my-project

This will clone the repository into the my-project folder, without the commit history.

Setup Git#

Now that you have cloned the repository, you can setup your Git configuration.

The saas-ui-pro-nextjs-starter-kit repository is configured as the upstream by default. To add your own repository as the origin, use the following command:

git remote add origin git@github.com:your-username/your-repository.git

You can pull the latest changes from the upstream repository using the following command:

git pull upstream main --allow-unrelated-histories

As your codebase diverges from saas-ui-pro-nextjs-starter-kit you will run into merge conflicts eventually, so at some point it might be easier to manually copy over any changes that you want to implement.

Login to the private package registry#

The Saas UI Pro packages are hosted on a private package registry (https://npm.saas-ui.dev).

After cloning the repository, log in to the private NPM registry with your license key.

  • The username is the Github username you used to activate the license.
  • The password is your license key that you received from Lemonsqueezy or Gumroad.
yarn npm login --scope saas-ui-pro --always-auth

Learn more about the private package registry

Install dependencies#

This project uses yarn 4 to manage dependencies, you can install all dependencies using the following command:

yarn

Yarn is shipped with the repository, so you don't need to install it globally. If you run into installation issues, you can try to install the latest version of Yarn using the following command:

yarn set version latest

In case this doesn't work, enable corepack and run yarn again.

corepack enable

Was this helpful?