Local development

Setup - Up and running in less than 5 minutes

Depending on your preference, you can either use Docker Sail or Laravel Herd to set up a local development environment for SaaSykit.

First of all, fork the SaaSykit repository to your GitHub account. You can do this by clicking the "Fork" button in the top right corner of the SaaSykit repository or SaaSykit Tenancy repository.

Docker Sail

Sail is a light-weight command-line interface for interacting with Laravel's default Docker development environment. Sail provides a great starting point for building a Laravel application using PHP, MySQL, and Redis without requiring prior Docker experience. You will need to have Docker installed on your machine to use Sail.

If you prefer to watch a video tutorial, you can watch the below video to get started: (all the commands used in the video are also listed below):

Once you get docker installed on your machine, you can follow the below steps to get started with SaaSykit.

2. Clone the forked SaaSykit repository to your local machine:

   git clone [your-forked-repository-url]

3. Change into the project directory

   cd [your-forked-repository-name]

4. Install composer dependencies

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

5. Copy .env.example to .env

   cp .env.example .env

6. Open the .env file and make sure that the ports defined under # local development settings are not in use by any other application on your machine. If they are, you can change them to any other port of your choice.

7. Run the below command to start the docker containers

   ./vendor/bin/sail up -d

8. Generate app secret

   ./vendor/bin/sail artisan key:generate

9. Run migrations

   ./vendor/bin/sail artisan migrate

10. Run seeders

    ./vendor/bin/sail artisan db:seed

11. Link storage

    ./vendor/bin/sail artisan storage:link

12. Install npm dependencies

    ./vendor/bin/sail npm install

13. Build assets

    ./vendor/bin/sail npm run build

14. Run the NPM (vite) watcher

    ./vendor/bin/sail npm run dev

That's it! 🎉 Open the browser and go to http://localhost:8080 (or change the port here if you choose another port in .env.). You should see the SaaSykit home page.

Laravel Herd

Laravel Herd is One click PHP development environment that lives in the menu bar and makes it easy to create and manage local development environments. It currently only works with macOS & Windows.

1. Download and install Laravel Herd. Check the following video for more information on how to install & configure it:

2. Once you have Laravel Herd installed, clone your SaaSykit forked repository that you created above into your Herd projects directory. Depending on your operating system, the Herd directory can be found in the following locations:

macOS

~/Herd check the Herd documentation for more information.

Windows

%USERPROFILE%/Herd check the Herd documentation for more information.

4. Open the terminal and navigate to the SaaSykit directory in the Herd projects directory:

macOS

cd ~/Herd/saasykit

Windows

cd %USERPROFILE%/Herd/saasykit

4. SaaSykit needs a database run, so you will need to install a database server locally (or if you have a Pro Herd license, then you will be able to use the database server provided by Herd). You can use MySQL or PostgreSQL for this.

5. Install composer dependencies

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

6. Copy .env.example to .env

   cp .env.example .env

7. Open the .env file and make sure that the ports defined under # local development settings are not in use by any other application on your machine. If they are, you can change them to any other port of your choice. Also make sure to update the database settings to match your local database settings. Another important thing to note is that you will need to update the APP_URL to match the URL that Herd provides you with. This is usually {directory-name}.test for example: http://saasykit.test.

8. Generate app secret

   php artisan key:generate

9. Run migrations

   php artisan migrate

10. Run seeders

    php artisan db:seed

11. Link storage

    php artisan storage:link

12. If you don't have Node & NPM installed, install them, then install npm dependencies

    npm install

13. Build assets

    npm run build

14. Run the NPM (vite) watcher

    npm run dev

Now navigate to the [name-of-your-project-folder].test (for example saasykit.test) in your browser. You should see the SaaSykit home page! 🎉

Creating an Admin User

You can create an admin user by running the below command:

Docker Sail

./vendor/bin/sail artisan app:create-admin-user

Laravel Herd

php artisan app:create-admin-user

With that use you can access the admin panel by going to /admin and logging in with the credentials you just created.

Demo data

SaaSykit comes with demo data that you can use to test the application and see how things look and work. The demo data includes products, plans, discounts, blog posts, and users, etc.

To install the demo data, you can run the below command:

Docker Sail

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

Laravel Herd

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

Development Resources

SaaSykit is based on the awesome Laravel framework. If you are new to Laravel, you can check out the Laravel documentation to get started with Laravel.

If you are already familiar with Laravel, you will easily be able to get started with SaaSykit as it follows the same coding standards and best practices as Laravel.

The admin panel and user dashboard are built using Filament. Filament is a beautiful, modern, and responsive admin panel for Laravel applications.

Keeping your fork up to date

To keep your fork up to date with the original repository, you can follow the below steps:

1. Add the original repository as a remote

   For SaaSykit use:

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

   For SaaSykit Tenancy use:

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

2. Fetch the branches and commits from the original repository

   git fetch upstream

3. Merge the changes from the original repository into your local branch

   git merge upstream/main

Then you can push the changes to your forked repository.

tip

It's a good practice to regularly keep your fork up to date with the original repository to get the latest features and bug fixes. This will also help you to avoid/reduce the merge conflicts in case you edited the same files that was updated in the original repository.