Getting started

Get your product key

Your access to all Highside Labs Composer packages is is managed by your product key. Right after checkout, you'll be redirected to the dashboard, where you'll see your key:

Initialize your project

Making a project using the starter kit is as simple as running composer create-project:

$ composer create-project highsidelabs/spapi-laravel-starter-kit my-project-dir \
    --repository=https://satis.highsidelabs.co

  Creating a "highsidelabs/spapi-laravel-starter-kit" project at "./my-project-dir"
  Installing highsidelabs/spapi-laravel-starter-kit (v1.0.0)
  - Downloading highsidelabs/spapi-laravel-starter-kit (v1.0.0)
    Authentication required (satis.highsidelabs.co):
      Username: [email protected]
      Password: 
  Do you want to store credentials for satis.highsidelabs.co in /Users/jesse/.composer/auth.json ? [Yn] Y
  - Installing highsidelabs/spapi-laravel-starter-kit (v1.0.0): Extracting archive
  ...

You will be prompted to enter your login credentials for satis.highsidelabs.co. Your username is the email associated with your tools.highsidelabs.co account, and your password is the product key referenced above. Then just cd into the new project directory.

Setup

Environment variables

As with a normal Laravel project, copy .env.exampleto .env. The environment variables that are specific to this project are the ones starting with SPAPI_ , but which ones you actually need to provide values for will depend on your use case. For now, just make sure you have the database-related environment variables filled in (DB_*). The rest of the environment variables will be covered in depth in later sections of this documentation (specifically: Credentials, OAuth, and Notifications).

Database

Database configuration is exactly the same as in a standard Laravel application, so we recommend referring to their documentation for any database setup questions. If you change your database setup to something other than Laravel's default SQLite option, you will need to run php artisan migrate to apply the database migrations to your new database.

Once you're done changing database configuration options, run php artisan db:seed to populate the database with some generic SP API data that's needed for the rest of the starter kit to work properly.

---

That's all the generic setup! Next, let's look at how to work with SP API credentials so that we can start actually making calls to the API.