Electrik

GitHub Install Try the demo

Home
Docs
Getting Started
Installation

View as Markdown Open in v0 Open in ChatGPT Open in Claude Open in Scira

# Installation

## Composer

```bash
composer require electrik/electrik:^5.4
```

## Artisan install

```bash
php artisan electrik:install
# or
php artisan electrik:install --migrate --force
```

| Flag | Effect |
|---|---|
| `--force` | Overwrite published `config/electrik.php` if it exists |
| `--migrate` | Run migrations, then `electrik:permissions:sync --teams` |

### What install configures

- Publishes `config/electrik.php`
- Wires Slate CSS import / `@source` in `resources/css/app.css` when possible
- Ensures Teamwork, Spatie permission teams mode, User model traits
- Sanctum, Cashier, session driver checks
- Stripe env placeholders and webhook tip
- Suggests `storage:link` for avatars

## After install

1. Copy Stripe keys into `.env` (`STRIPE_KEY`, `STRIPE_SECRET`, `STRIPE_WEBHOOK_SECRET`)
2. Set `ELECTRIK_OPERATOR_EMAILS` if you want `/ops`
3. Optional Socialite: `ELECTRIK_SOCIALITE_PROVIDERS=google,github` (+ `config/services.php`)
4. `php artisan electrik:stripe:sync` — pull products/prices into Electrik tables
5. `php artisan storage:link`
6. Point Cashier webhook at your app (or use Stripe CLI locally)
7. Optional: `php artisan electrik:seed-demo`

Screenshots of the shell after install:

![Dashboard](/images/docs/docs-dashboard.png)

![Billing](/images/docs/docs-billing.png)

## Disable features via env

| Env | Default | Purpose |
|---|---|---|
| `ELECTRIK_REGISTRATION` | `true` | Allow public registration |
| `ELECTRIK_EMAIL_VERIFICATION` | `true` | Require verified email |
| `ELECTRIK_ONBOARDING` | `true` | Force onboarding wizard |
| `ELECTRIK_REQUIRE_SUBSCRIPTION` | `false` | Gate app behind active subscription |
| `ELECTRIK_HOME` | `/dashboard` | Post-login home |
| `ELECTRIK_MAGIC_LINK` | `true` | Email magic-link sign-in |
| `ELECTRIK_LOGIN_ALERTS` | `true` | New-IP login notifications |
| `ELECTRIK_OPERATOR_EMAILS` | _(empty)_ | Comma list for `/ops` |

Full map: [Configuration](/docs/core-concepts/configuration).

## Optional: Slate Blocks

Curated marketing/app sections (`<x-slate-block::*>`):

```bash
composer require electrik/slate-blocks:^0.1
```

Add a Tailwind `@source` for `vendor/electrik/slate-blocks/resources/views/**/*.blade.php`. Gallery: [slate.electrik.dev/blocks](https://slate.electrik.dev/blocks).

## Agents (Cursor)

If you use Cursor, copy the **electrik-install** skill from the Electrik repo (`.cursor/skills/electrik-install`) into your project so agents install Composer packages and Blade components instead of inventing React/shadcn.

Installation

Composer

composer require electrik/electrik:^5.4

Artisan install

php artisan electrik:install
# or
php artisan electrik:install --migrate --force

Flag	Effect
`--force`	Overwrite published `config/electrik.php` if it exists
`--migrate`	Run migrations, then `electrik:permissions:sync --teams`

What install configures

Publishes config/electrik.php
Wires Slate CSS import / @source in resources/css/app.css when possible
Ensures Teamwork, Spatie permission teams mode, User model traits
Sanctum, Cashier, session driver checks
Stripe env placeholders and webhook tip
Suggests storage:link for avatars

After install

Copy Stripe keys into .env (STRIPE_KEY, STRIPE_SECRET, STRIPE_WEBHOOK_SECRET)
Set ELECTRIK_OPERATOR_EMAILS if you want /ops
Optional Socialite: ELECTRIK_SOCIALITE_PROVIDERS=google,github (+ config/services.php)
php artisan electrik:stripe:sync — pull products/prices into Electrik tables
php artisan storage:link
Point Cashier webhook at your app (or use Stripe CLI locally)
Optional: php artisan electrik:seed-demo

Screenshots of the shell after install:

Dashboard

Billing

Disable features via env

Env	Default	Purpose
`ELECTRIK_REGISTRATION`	`true`	Allow public registration
`ELECTRIK_EMAIL_VERIFICATION`	`true`	Require verified email
`ELECTRIK_ONBOARDING`	`true`	Force onboarding wizard
`ELECTRIK_REQUIRE_SUBSCRIPTION`	`false`	Gate app behind active subscription
`ELECTRIK_HOME`	`/dashboard`	Post-login home
`ELECTRIK_MAGIC_LINK`	`true`	Email magic-link sign-in
`ELECTRIK_LOGIN_ALERTS`	`true`	New-IP login notifications
`ELECTRIK_OPERATOR_EMAILS`	(empty)	Comma list for `/ops`

Full map: Configuration.

Optional: Slate Blocks

Curated marketing/app sections (<x-slate-block::*>):

composer require electrik/slate-blocks:^0.1

Add a Tailwind @source for vendor/electrik/slate-blocks/resources/views/**/*.blade.php. Gallery: slate.electrik.dev/blocks.

Agents (Cursor)

If you use Cursor, copy the electrik-install skill from the Electrik repo (.cursor/skills/electrik-install) into your project so agents install Composer packages and Blade components instead of inventing React/shadcn.