Installing Spike

You will need a valid license key to install Spike.

You can get a Single or Unlimited license from here.

Prerequisites

Before you install Spike, you should know the requirements for using Spike.

Laravel 10+
PHP 8.1+
Livewire 3+

For requirements for different payment providers, please check their respective documentation pages:

Installing the package via Composer

First you should add Spike's private repository to your composer.json file:

{
    "repositories": [
        {
            "type": "composer",
            "url": "https://spike.composer.sh"
        }
    ],
}

Once the repository has been added to the composer.json file, you can install Spike like any other composer package using the composer require command:

composer require opcodes/spike

Once you do, you will be prompted to authenticate in order to download Spike:

Loading composer repositories with package information
Authentication required (spike.composer.sh):
Username: [licensee-email]
Password: [license-key]

The username will be your email address and the password will be equal to your license key. If you have the Single license key, you will need to append your selected domain to the license key. If instead you have the Unlimited license, you don't need to append any domain name.

For example, let's say you have the following license information:

Licensee email: arunas@arunas.dev
License key: bcee7a9d-0801-4b06-aa5f-62ec38ab627e
License type: Single (one project)
Activation domain: arunas.dev

This will require your licensee to enter the following information when prompted for their credentials:

Loading composer repositories with package information
Authentication required (spike.composer.sh):
Username: arunas@arunas.dev
Password: bcee7a9d-0801-4b06-aa5f-62ec38ab627e:arunas.dev

To avoid manually typing these credentials, you may create a Composer auth.json file and use the same details as described above.

{
    "http-basic": {
        "spike.composer.sh": {
            "username": "arunas@arunas.dev",
            "password": "bcee7a9d-0801-4b06-aa5f-62ec38ab627e:arunas.dev"
        }
    }
}

The above username and password are just an example.

Don't forget to replace the values with your own license information.

It is not recommended to commit the auth.json file to your version control repository, because it contains sensitive information like your email and license key.

Authenticating Spike in Continuous Integration (CI) Environments

You should not store your Composer auth.json file inside your project's version control repository. However, there may be times you wish to download Spike inside a CI environment like GitHub Actions or Chipper CI.

For instance, you may wish to run tests for your project. To authenticate Spike in these situations, you can use Composer to set the configuration option inside your CI system's pipeline, injecting environment variables containing the credentials you used above to require the Composer package:

composer config http-basic.spike.composer.sh ${SPIKE_USERNAME} ${SPIKE_LICENSE_KEY}

Using the example username & password above, the command would look like this:

composer config http-basic.spike.composer.sh arunas@arunas.dev bcee7a9d-0801-4b06-aa5f-62ec38ab627e:arunas.dev

Downloading package

Instead of using Composer to install Spike, you can instead download the compressed package directly from our Downloads page.

Next steps