SaaSykit

https://saasykit.com/docs
Admin
SaaSykit is a comprehensive SaaS starter kit built with Laravel and Filament, offering pre-built...
Tokens:39,284
Snippets:294
Trust Score:7.9
Update:11 months ago
Show doc for...
Tokens:
Raw
### Install NPM Dependencies

Source: https://saasykit.com/docs/getting-started/development

Installs JavaScript dependencies required for the project using npm.

```bash
npm install
```

```bash
./vendor/bin/sail npm install
```

--------------------------------

### Run NPM Watcher (Vite)

Source: https://saasykit.com/docs/getting-started/development

Starts the Vite development server with a watcher to automatically recompile assets on changes.

```bash
npm run dev
```

```bash
./vendor/bin/sail npm run dev
```

--------------------------------

### Install SaaSykit Filament Onboarding Plugin

Source: https://saasykit.com/docs/onboarding

This command installs the SaaSykit Filament Onboarding plugin into your project using Composer. Ensure you have added the private repository to your composer.json first.

```bash
composer require saasykit/filament-onboarding
```

--------------------------------

### Copy Environment File

Source: https://saasykit.com/docs/getting-started/development

Copies the example environment file to a new file named .env. This is a standard practice in Laravel projects to configure local settings.

```bash
cp .env.example .env
```

--------------------------------

### SSH into Server and Copy .env Example

Source: https://saasykit.com/docs/getting-started/production/deployer

This command sequence first logs you into the remote server via SSH using Deployer. It then copies the example environment file (`.env.example`) to the shared directory, renaming it to `.env` for your application's configuration.

```bash
./vendor/bin/dep ssh
cp .env.example ../../shared/.env
```

--------------------------------

### Run SaaSyKit Tenancy Installer Artisan Command

Source: https://saasykit.com/docs/multi-tenancy/multi-database-tenancy

This Artisan command executes the installer for the SaaSyKit Filament Tenancy package. It publishes configuration files, service providers, route files, and creates migration directories. It also prompts for model modifications.

```bash
php artisan filament-tenancy-for-laravel:run-installer
```

--------------------------------

### Configure .env.testing for Automated Tests

Source: https://saasykit.com/docs/getting-started/development

Examples of how to configure the `.env.testing` file for running automated tests with different database connections. It shows settings for MySQL and PostgreSQL, including connection details, host, port, database name, username, and password.

```env
DB_CONNECTION=mysql
DB_HOST=localhost
DB_PORT=3306
DB_DATABASE=saasykit_test
DB_USERNAME=YOUR_USERNAME
DB_PASSWORD=YOUR_PASSWORD
```

```env
DB_CONNECTION=pgsql
DB_HOST=localhost
DB_PORT=5432
DB_DATABASE=saasykit_test
DB_USERNAME=YOUR_USERNAME
DB_PASSWORD=YOUR_PASSWORD
```

--------------------------------

### Install Demo Data with Laravel Herd or Docker Sail

Source: https://saasykit.com/docs/getting-started/development

Commands to seed the SaaSykit application with demo data, including products, plans, discounts, and users. This is useful for testing and demonstration purposes. Execution is supported via Laravel Herd or Docker Sail.

```shell
php artisan db:seed "Database\Seeders\Demo\DemoDatabaseSeeder"
```

```shell
./vendor/bin/sail artisan db:seed "Database\Seeders\Demo\DemoDatabaseSeeder"
```

--------------------------------

### Install Composer Dependencies

Source: https://saasykit.com/docs/getting-started/development

Installs Composer dependencies for the project, ignoring platform requirements and skipping scripts. This command is used in both Laravel Herd and Docker Sail setups.

```bash
composer install --ignore-platform-reqs --no-interaction --no-scripts --prefer-dist
```

--------------------------------

### Start Docker Containers with Sail

Source: https://saasykit.com/docs/getting-started/development

Starts the Docker containers defined in the Docker Compose configuration for the Laravel Sail development environment.

```bash
./vendor/bin/sail up -d
```

--------------------------------

### Clone SaaSykit Tenancy Repository with Git

Source: https://saasykit.com/docs/getting-started/development

Clones the SaaSykit Tenancy repository from GitHub. Use this command if you are setting up the tenancy features of SaaSykit.

```bash
git clone https://github.com/saasykit/saasykit-tenancy.git
```

--------------------------------

### Publish and Run Filament Onboarding Migrations

Source: https://saasykit.com/docs/onboarding

These commands publish the migration files for the Filament Onboarding plugin and then run them to set up the necessary database tables. This is a crucial step after installing the plugin.

```bash
php artisan vendor:publish --tag="filament-onboarding-migrations"
php artisan migrate
```

--------------------------------

### Run Database Migrations

Source: https://saasykit.com/docs/getting-started/development

Applies database migrations to set up the database schema. This command is executed via Artisan.

```bash
php artisan migrate
```

```bash
./vendor/bin/sail artisan migrate
```

--------------------------------

### Build Assets

Source: https://saasykit.com/docs/getting-started/development

Compiles and builds project assets (CSS, JavaScript) for production.

```bash
npm run build
```

```bash
./vendor/bin/sail npm run build
```

--------------------------------

### Enable Multi-tenant Onboarding

Source: https://saasykit.com/docs/onboarding

This example demonstrates how to configure the FilamentOnboardingPlugin for multi-tenant environments. By setting `->multiTenancy(true)`, the plugin will track onboarding status for the tenant rather than individual users.

```php
use Saasykit\FilamentOnboarding\FilamentOnboardingPlugin;

class TenantPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            // some other configurations
            ->plugins([
                FilamentOnboardingPlugin::make()
                    ->multiTenancy(true),
            ]);
    }
}
```

--------------------------------

### Install Laravel Wallet Package

Source: https://saasykit.com/docs/how-to/top-up-balance-and-credit-management

Command to install the Laravel Wallet package using Composer. This is the initial step to enable wallet functionalities in your Laravel application.

```bash
composer require bavix/laravel-wallet
```

--------------------------------

### Install Composer Packages

Source: https://saasykit.com/docs/getting-started/production/deployer

Install all necessary PHP dependencies for your Saasykit project using Composer. Ensure Composer is installed globally or available in your PATH.

```bash
composer install
```

--------------------------------

### Seed Database

Source: https://saasykit.com/docs/getting-started/development

Populates the database with initial data using seeders. This command is executed via Artisan.

```bash
php artisan db:seed
```

```bash
./vendor/bin/sail artisan db:seed
```

--------------------------------

### Run Deployer Provisioning Command

Source: https://saasykit.com/docs/getting-started/production/deployer

Execute the Deployer provisioning command to set up your server. This command installs necessary packages and configures the environment. Ensure you replace `{{user}}` and provide the correct identity file path if applicable.

```bash
./vendor/bin/dep provision -o remote_user={{user}}  -o become=root -o identity_file=~/path/to/private/key.pem -vvv  
```

--------------------------------

### Clone Forked Git Repository

Source: https://saasykit.com/docs/getting-started/development

Clones a forked repository from GitHub to your local machine. Replace '[your-forked-repository-url]' with the actual URL of your forked repository.

```bash
git clone [your-forked-repository-url]
```

--------------------------------

### Clone SaaSykit Repository with Git

Source: https://saasykit.com/docs/getting-started/development

Clones the SaaSykit repository from GitHub to your local machine. This is the recommended method for managing multiple projects or using SaaSykit with other forks.

```bash
git clone https://github.com/saasykit/saasykit.git
```

--------------------------------

### Install SaaSyKit Filament Tenancy Package via Composer

Source: https://saasykit.com/docs/multi-tenancy/multi-database-tenancy

This command installs the saasykit/filament-tenancy-for-laravel package into your Laravel project using Composer.

```bash
composer require saasykit/filament-tenancy-for-laravel
```

--------------------------------

### Navigate to SaaSykit Directory (Windows)

Source: https://saasykit.com/docs/getting-started/development

Changes the current directory to the SaaSykit project folder within the Herd projects directory on Windows.

```bash
cd %USERPROFILE%/Herd/saasykit
```

--------------------------------

### Navigate to SaaSykit Tenancy Directory with Git

Source: https://saasykit.com/docs/getting-started/development

Changes the current directory to the root of the cloned SaaSykit Tenancy project. This command is used after cloning the tenancy repository.

```bash
cd saasykit-tenancy
```

--------------------------------

### Install Chromium on Ubuntu/Debian

Source: https://saasykit.com/docs/open-graph-images

Installs the chromium-browser package on Ubuntu or Debian-based systems using apt-get. This is a prerequisite for SaaSykit's open graph image generation.

```bash
sudo apt-get install -y chromium-browser
```

--------------------------------

### Push Code to Git Repository

Source: https://saasykit.com/docs/getting-started/development

Pushes the local repository's main branch to the remote 'origin' repository and sets it to track the remote branch. This uploads your code to your GitHub repository.

```bash
git push -u origin main
```

--------------------------------

### Navigate to Project Directory with Git

Source: https://saasykit.com/docs/getting-started/development

Changes the current directory to the root of the cloned SaaSykit project. This command is essential after cloning any repository to work within its files.

```bash
cd saasykit
```

--------------------------------

### Link Storage Directory

Source: https://saasykit.com/docs/getting-started/development

Creates a symbolic link from the public/storage directory to the storage/app/public directory, allowing public access to stored files. This command is executed via Artisan.

```bash
php artisan storage:link
```

```bash
./vendor/bin/sail artisan storage:link
```

--------------------------------

### Configure Composer Repositories for SaaSyKit Package

Source: https://saasykit.com/docs/multi-tenancy/multi-database-tenancy

This snippet shows how to add the SaaSyKit private repository to your composer.json file, which is necessary before installing the package.

```json
{
    "repositories": [
        {
            "type": "vcs",
            "url": "https://code.saasykit.com/saasykit/filament-tenancy-for-laravel.git"
        }
    ]
}
```

--------------------------------

### Navigate to SaaSykit Directory (macOS)

Source: https://saasykit.com/docs/getting-started/development

Changes the current directory to the SaaSykit project folder within the Herd projects directory on macOS.

```bash
cd ~/Herd/saasykit
```

--------------------------------

### Add FilamentOnboardingPlugin to DashboardPanelProvider

Source: https://saasykit.com/docs/onboarding

This snippet shows how to register the FilamentOnboardingPlugin within your Filament DashboardPanelProvider. This will enable the default onboarding form upon installation.

```php
use Saasykit\FilamentOnboarding\FilamentOnboardingPlugin;

class DashboardPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            // some other configurations
            ->plugins([
                FilamentOnboardingPlugin::make(),  // Add this line
            ]);
    }
}
```

--------------------------------

### Navigate to Project Directory (Docker Sail)

Source: https://saasykit.com/docs/getting-started/development

Changes the current directory to the root of the SaaSykit project when using Docker Sail.

```bash
cd [your-forked-repository-name]
```

--------------------------------

### Add New Git Remote Origin

Source: https://saasykit.com/docs/getting-started/development

Adds a new remote repository named 'origin' pointing to your personal GitHub repository. This allows you to push your cloned code to your own account.

```bash
git remote add origin https://github.com/your-username/your-repo.git
```

--------------------------------

### App Layout Example (HTML)

Source: https://saasykit.com/docs/components/layouts

The default layout for application pages in SaaSykit. It serves as the main container for displaying primary content.

```html
<x-layouts.app>
    ...
</x-layouts.app>
```

--------------------------------

### Enable Onboarding Conditionally with Callable

Source: https://saasykit.com/docs/onboarding

Enable the FilamentOnboardingPlugin dynamically based on a condition provided by a callable. This example shows enabling tenant onboarding only if the user has specific tenant admin permissions.

```php
use Saasykit\FilamentOnboarding\FilamentOnboardingPlugin;
use App\Services\TenantPermissionService;
use Illuminate\Panel\Panel;
use Illuminate\Panel\Provider\PanelProvider;
use Filament\Filament;

class TenantPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            // some other configurations
            ->plugins([
                FilamentOnboardingPlugin::make()
                    ->enabledUsing(function (TenantPermissionService $service) {
                        return $service->tenantUserHasPermissionTo(Filament::getTenant(), auth()->user(), TenancyPermissionConstants::PERMISSION_UPDATE_TENANT_SETTINGS);
                    })
            ]);
    }
}
```

--------------------------------

### Generate Application Key

Source: https://saasykit.com/docs/getting-started/development

Generates a new application key for Laravel, which is used for session encryption and other security-related purposes. This command is executed via Artisan.

```bash
php artisan key:generate
```

```bash
./vendor/bin/sail artisan key:generate
```

--------------------------------

### Configure Chrome Binary Path

Source: https://saasykit.com/docs/open-graph-images

Example configuration for the 'chrome_binary' setting in SaaSykit's 'config/open-graphy.php' file. Setting it to null enables auto-discovery of the browser binary.

```php
'chrome_binary' => null,
```

--------------------------------

### Add Private Repository to Composer.json

Source: https://saasykit.com/docs/onboarding

This code snippet shows how to add the SaaSykit private repository to your composer.json file. This is a necessary step before you can install the filament-onboarding package, as it's hosted privately.

```json
{
    "repositories": [
        {
        "type": "vcs",
        "url": "https://code.saasykit.com/saasykit/filament-onboarding.git"
        }
    ]

}
```

--------------------------------

### Fetch and Merge Upstream Changes

Source: https://saasykit.com/docs/getting-started/development

Commands to fetch all branches and commits from the 'upstream' remote repository and then merge the changes from the 'main' branch into your local branch. This process updates your forked repository with the latest code from the original SaaSykit project.

```git
git fetch upstream
```

```git
git merge upstream/main
```

--------------------------------

### Add Upstream Remote Repository

Source: https://saasykit.com/docs/getting-started/development

Instructions for adding the original SaaSykit repository as a remote named 'upstream'. This is a crucial step for keeping your forked repository synchronized with the main project. Two URLs are provided for SaaSykit and SaaSykit Tenancy.

```git
git remote add upstream https://github.com/saasykit/saasykit.git
```

```git
git remote add upstream https://github.com/saasykit/saasykit-tenancy.git
```

--------------------------------

### Forward Stripe Webhooks Locally with Stripe CLI

Source: https://saasykit.com/docs/development/payment-webhooks

Use the Stripe CLI to forward incoming Stripe webhooks to your local development server. Ensure the Stripe CLI is installed and replace 'localhost:8080' with your local server's address.

```bash
stripe listen --forward-to localhost:8080/api/payments-providers/stripe/webhook --skip-verify
```

--------------------------------

### Display All Plans with SaaSykit Component

Source: https://saasykit.com/docs/components/plans

This example demonstrates how to use the `<x-plans.all>` component to display all available plans. It utilizes attributes to control features like saving rate calculation and preselecting a pricing interval. Ensure plans are active and have prices defined with the correct currency in the Admin Panel for proper display.

```html
<x-plans.all calculate-saving-rates="true" preselected-interval="year"></x-plans.all>
```

--------------------------------

### Install Chromium on Laravel Sail (Apple Silicon)

Source: https://saasykit.com/docs/open-graph-images

Installs chromium on Laravel Sail for users with Apple Silicon Macs. This involves adding a PPA, updating package lists, and installing chromium.

```bash
apt-get install software-properties-common
add-apt-repository ppa:xtradeb/apps -y
apt update
apt install chromium
```

--------------------------------

### Publish Filament Onboarding Views (Optional)

Source: https://saasykit.com/docs/onboarding

This command publishes the view files for the Filament Onboarding plugin, allowing for customization. This step is optional and only needed if you intend to modify the plugin's views.

```bash
php artisan vendor:publish --tag="filament-onboarding-views"
```

--------------------------------

### Install Google Chrome on MacOS

Source: https://saasykit.com/docs/open-graph-images

Installs the Google Chrome browser on MacOS using the Homebrew package manager. This is a dependency for SaaSykit's open graph image generation.

```bash
brew install --cask google-chrome
```

--------------------------------

### Laravel Forge Deployment Script

Source: https://saasykit.com/docs/getting-started/production/laravel-forge

This script automates the deployment process on a Laravel Forge server. It pulls the latest code, installs dependencies, reloads PHP-FPM, runs database migrations and seeding, generates a sitemap, terminates Horizon, and builds frontend assets. It requires `git`, `composer`, `npm`, and PHP to be installed on the server.

```bash
cd /home/forge/default  
git pull origin $FORGE_SITE_BRANCH  

$FORGE_COMPOSER install --no-dev --no-interaction --prefer-dist --optimize-autoloader  

( flock -w 10 9 || exit 1  
    echo 'Restarting FPM...'; sudo -S service $FORGE_PHP_FPM reload ) 9>/tmp/fpmlock  

if [ -f artisan ]; then  
    $FORGE_PHP artisan migrate --force  
    $FORGE_PHP artisan db:seed --force  
    $FORGE_PHP artisan app:generate-sitemap  
      
    $FORGE_PHP artisan horizon:terminate  
fi  

npm ci && npm run build  

```

--------------------------------

### Register Tenancy Service Provider in Laravel

Source: https://saasykit.com/docs/multi-tenancy/multi-database-tenancy

This snippet demonstrates how to register the TenancyServiceProvider in your Laravel application's bootstrap/providers.php file after the package installation.

```php
return [
    // ...
    App\Providers\TenancyServiceProvider::class, // <-- add it here at the end of the array
];
```

--------------------------------

### Create Custom Onboarding Page with Wizard Form

Source: https://saasykit.com/docs/onboarding

This code defines a custom Filament page that extends Saasykit's OnboardingPage. It demonstrates how to create a multi-step wizard form for user onboarding, including input fields for name and email.

```php
<?php

namespace App\Filament\Dashboard\Pages;

use Filament\Actions\Action;
use Filament\Forms\Components\TextInput;
use Filament\Schemas\Components\Wizard;
use Saasykit\FilamentOnboarding\Pages\OnboardingPage;

class CustomOnboardingPage extends OnboardingPage
{
    public string $name;
    public string $email;

    protected function getFormSchema(): array
    {
        return [
            Wizard::make([
                Wizard\Step::make('Personal Information')
                    ->schema([
                        TextInput::make('name'),
                        TextInput::make('email'),
                    ]),
                Wizard\Step::make('Repository')
                    ->schema([
                        // ...
                    ]),
                Wizard\Step::make('Get Started')
                    ->schema([
                        // ...
                    ]),
            ])->nextAction(
                fn (Action $action) => $action->label('Next step')->color('gray')->outlined(),
            )
        ];
    }
      
    public function submit()
    {
        // $this->validate();

        // SAVE THE SETTINGS HERE

        $this->onboarded();   // don't forget to call this method to mark the user/tenant as onboarded
    }
}
```

--------------------------------

### Focus Layout Example (HTML)

Source: https://saasykit.com/docs/components/layouts

A layout template in SaaSykit designed for pages that emphasize a specific element, such as login or registration forms.

```html
<x-layouts.focus>
    ...
</x-layouts.focus>
```

--------------------------------

### Retry Provisioning Website Step

Source: https://saasykit.com/docs/getting-started/production/deployer

If the provisioning process fails specifically at the `provision:website` step due to permission issues, use this command to restart from that specific step. This helps in resolving admin permission-related problems.

```bash
./vendor/bin/dep provision --start-from provision:website -vvv  
```

--------------------------------

### Focus Center Layout Example (HTML)

Source: https://saasykit.com/docs/components/layouts

This SaaSykit layout centers a specific element on the page, ideal for displaying messages or centered forms.

```html
<x-layouts.focus-center>
    ...
</x-layouts.focus-center>
```

--------------------------------

### Add Plugin Repository to Composer

Source: https://saasykit.com/docs/onboarding

Configure your composer.json file to include a forked or private repository for the filament-onboarding plugin. This is useful for production deployments.

```json
{
    "repositories": [
        {
            "type": "vcs",
            "url": "git@github.com:{YOUR_GITHUB_USERNAME}/filament-onboarding.git"
        }
    ]
}
```

--------------------------------

### Configure Deployer (`deploy.php`)

Source: https://saasykit.com/docs/getting-started/production/deployer

Set up the `deploy.php` configuration file for Deployer. This includes specifying the remote user, deployment path, server host, repository URL, PHP version, and other critical deployment parameters.

```php
$remoteUser = 'deployer';   // the user that will be used to connect to remote server and deploy the app  
$sudoPassword = '';  // the sudo password of the remote user  
  
$deployPath = '~/app';      // the path where the app will be deployed on the remote server  
  
$host = '';    // the host of the remote server (can be an IP or domain)  
$domain = '';   // the domain of the app  
  
$repository = 'git@github.com:username/saasykit.git';      // has to be in the SSH format  
$subDirectory = 'saasykit';                               // the subdirectory of the repository where the app is located (this is the directory that contains the composer.json file)  
  
$phpVersion = '8.3'; // the version of PHP to be installed on the server  
```

--------------------------------

### Allow Skipping Onboarding in Filament Panel

Source: https://saasykit.com/docs/onboarding

Configure the FilamentOnboardingPlugin to allow users to skip the onboarding process. A 'Skip' button will be presented on the onboarding page.

```php
use Saasykit\FilamentOnboarding\FilamentOnboardingPlugin;
use Illuminate\Panel\Panel;
use Illuminate\Panel\Provider\PanelProvider;

class DashboardPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            // some other configurations
            ->plugins([
                FilamentOnboardingPlugin::make()
                    ->skippable(true),
            ]);
    }
}
```

--------------------------------

### Publish Laravel Configuration

Source: https://saasykit.com/docs/themes-and-styles/themes/diamonds-theme

This Artisan command is used to publish configuration files for Laravel applications. It is a prerequisite for modifying view paths to enable theme comparison.

```bash
php artisan config:publish  
```

--------------------------------

### Run Deployer Deployment Command

Source: https://saasykit.com/docs/getting-started/production/deployer

This command initiates the deployment process for your SaaSykit application using Deployer. It automates the transfer of your application code to the remote server based on the `deploy.php` configuration.

```bash
./vendor/bin/dep deploy
```

--------------------------------

### Run Database Migrations

Source: https://saasykit.com/docs/how-to/top-up-balance-and-credit-management

Command to run the database migrations for the Laravel Wallet package. This creates the necessary tables in your database, including the customized transaction table.

```bash
php artisan migrate
```

--------------------------------

### Publish Laravel Wallet Configuration

Source: https://saasykit.com/docs/how-to/top-up-balance-and-credit-management

Command to publish the configuration file for the Laravel Wallet package. This allows customization of settings, including table names and models.

```bash
php artisan vendor:publish --tag=laravel-wallet-config
```

--------------------------------

### Compile Assets with NPM

Source: https://saasykit.com/docs/themes-and-styles/themes/diamonds-theme

This command compiles the project's front-end assets after theme files have been copied. It is essential for the theme's styles and scripts to be processed and ready for the browser.

```bash
npm run dev  
```
Tokens:
Raw