Installation

This page gets the code onto your machine. Local development covers the full first run (database, seeding, tenants, dev server) in more detail.

Repository access → clone → composer install + .env → migrate and seed → npm install → open APP_URL

1. Get repository access

After purchase, your GitHub account is automatically invited to the kit repository. See Repository access.

2. Clone the kit

Vue

git clone https://github.com/erag-labs/saas-laravel-starter-kit-vue.git my-saas

React

git clone https://github.com/erag-labs/saas-laravel-starter-kit-react.git my-saas

Svelte

git clone https://github.com/erag-labs/saas-laravel-starter-kit-svelte.git my-saas

cd my-saas

Keep updates easy

Rename the kit remote to upstream right away and push to your own repository as origin. This makes weekly updates a simple merge. See Updates.

git remote rename origin upstream
git remote add origin git@github.com:your-org/my-saas.git

Important

Keep your copy of the kit in a private repository. If you push it to a public repository, anyone can see the full source code of the paid starter kit — and publishing it is not allowed under the SaaS Laravel Commercial License.

Choose Private when you create the repository. Already created it as public? Open the repository's Settings → General → Danger Zone → Change visibility and switch it to private.

Private

PublicAnyone on the internet can see this repository.

PrivateYou choose who can see and commit to this repository.

3. Install and configure

composer install
cp .env.example .env
php artisan key:generate

Edit .env (at minimum APP_URL, APP_DOMAIN and the DB_* keys) and create the database. Then:

php artisan migrate --seed
npm install

Each step is explained in Local development.

One-command setup

composer setup runs most of the steps above in one go:

Step	Command
Install PHP dependencies	composer install
Create .env (only if it does not exist)	copies .env.example
App key	php artisan key:generate
Central migrations	php artisan migrate --force
Frontend	npm install, npm run build

No seeding

composer setup does not seed the database, and it migrates using whatever .env contains. Create and edit .env first, create the database, run composer setup, then run php artisan db:seed.

Open the app

With Herd, link the project to the domain you set in APP_DOMAIN:

herd link vue   # serves this folder as vue.test and *.vue.test

Open APP_URL (for example http://vue.test) and sign in with a seeded user.