Skip to content

Latest commit

 

History

History
72 lines (45 loc) · 3 KB

installation.md

File metadata and controls

72 lines (45 loc) · 3 KB
Raw

Installation

Requirements

If you need support for Laravel 10.x or higher, please upgrade to the current generation of Spark.

Laravel Spark has a few requirements you should be aware of before installing:

  • Composer
  • Laravel Framework 9.0
  • Laravel Mix
  • Laravel Cashier
  • Laravel UI
  • Bootstrap 4 (SASS)
  • Node.js & NPM

Before installing Spark, make sure you have the latest version of Node and NPM. You can download a graphical installer for Node on the Node website.

The Vue.js JavaScript framework is utilized on the registration and settings pages; however, you are free to build the "bulk" of your application using the JavaScript framework of your choice, or no JavaScript framework at all.

Installation

Installation Via Composer

Spark provides a Satis repository which makes it simple to install Spark just like any other Composer package. First, make sure you have purchased a Spark license and joined the Spark GitHub repository.

Create a new Laravel project using the Laravel installer:

laravel new project-name

Next, add the following dependencies to your composer.json file's require section:

"laravel/spark-aurelius": "~12.0",
"laravel/ui": "^3.0",

Next, run the composer update command. You may be prompted for a GitHub token in order to install the private Spark repository. Composer will provide a link where you can create this token. Once the dependencies are installed, add the following service providers to your app.php configuration file:

Laravel\Spark\Providers\SparkServiceProvider::class,
Laravel\Cashier\CashierServiceProvider::class,

Next, run the spark:install --force command:

php artisan spark:install --force

Once Spark is installed, add the following provider to your app.php configuration file:

App\Providers\SparkServiceProvider::class,

Finally, you are ready to run the npm install, npm run dev, and php artisan migrate commands. Once these commands have completed, you are ready to enjoy Spark!

Linking The Storage Directory

Once Spark is installed, you should link the public/storage directory to your storage/app/public directory. Otherwise, user profile photos stored on the local disk will not be available:

php artisan storage:link

Installation Types

The default spark command will generate a project that supports individual user plans. However, you may also create projects that use team billing.

spark new project-name --team-billing