Installation

WhatsMine ships with an interactive installer that does the heavy lifting. A typical install takes only a few minutes.

📸 Screenshot: Terminal showing the php artisan saas:install wizard running.

Overview

The installation has five steps:

  1. Upload / extract the files and install dependencies
  2. Create the database
  3. Configure the .env file
  4. Run the installer (php artisan saas:install)
  5. Build the frontend assets

Step 1 — Get the files and install dependencies

Extract the package onto your server, then from the project root run:

# Install PHP dependencies
composer install

# Install Node dependencies (needed to build the UI)
npm install

Shared hosting?

If your host doesn't give you SSH access to run Composer/Node, you can run these on your local machine, then upload the resulting vendor/ folder and the built public/build/ assets. Most VPS and managed hosts support SSH.

Step 2 — Create the database

Create an empty MySQL database and a user with full privileges on it. Note the database name, username and password — you'll need them in the next step.

CREATE DATABASE whatsmine CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
CREATE USER 'whatsmine'@'localhost' IDENTIFIED BY 'a-strong-password';
GRANT ALL PRIVILEGES ON whatsmine.* TO 'whatsmine'@'localhost';
FLUSH PRIVILEGES;

Step 3 — Configure your environment

Copy the example environment file:

cp .env.example .env

Open .env and set at least these values:

APP_NAME="WhatsMine"
APP_ENV=production
APP_DEBUG=false
APP_URL=https://your-domain.com

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=whatsmine
DB_USERNAME=whatsmine
DB_PASSWORD=a-strong-password

You can configure mail, billing and integrations now or later from the admin panel. The full list of variables is in the Configuration reference.

Step 4 — Run the installer

This single command sets everything up:

php artisan saas:install

The wizard will:

  1. Run all database migrations (creates every table).
  2. Seed internationalisation defaults (base translations and locales).
  3. Prompt you to create the Super-Admin account — your platform login. You'll be asked for a name, email and password.
  4. Seed the default plans — Free, Starter, Pro and Business (you can edit or delete these later).
  5. Generate the application key and clear caches.

Installer options

CommandWhat it does
php artisan saas:installStandard install (migrate + seed defaults + create admin).
php artisan saas:install --seedAlso seeds demo data (sample contacts, conversations, etc.) — great for evaluating.
php artisan saas:install --freshDrops all existing tables and re-creates them. Use only on a clean/wiped database.
php artisan saas:install --fresh --seedFresh database with demo data.

Warning

--fresh permanently deletes all data. Never run it on a live database.

Step 5 — Build the frontend

Compile the React UI for production:

npm run build

That's it — your installation is complete.

Step 6 — Log in

  • Platform admin panel: https://your-domain.com/admin/login — sign in with the Super-Admin account you created.
  • Customer application: https://your-domain.com/login — where your business customers sign in.
  • Marketing site: https://your-domain.com/ — the public landing page.

📸 Screenshot: The admin login screen at /admin/login.

After logging in, before you launch:

  1. Set up your queue worker and cron — see Deployment. Without these, campaigns, inbound messages and emails won't process.
  2. Brand the platform — Branding & Settings.
  3. Configure email (SMTP) — Email System.
  4. Connect a payment gateway — Payment Gateways.
  5. Add your integrations — Integrations.
  6. Run the Going Live Checklist.

Quick command reference

composer install            # PHP dependencies
npm install                 # Node dependencies
cp .env.example .env        # create env file
php artisan saas:install    # interactive setup wizard
npm run build               # compile the UI
php artisan serve           # (local only) start a dev server
Last Updated: