README

📸 Screenshots & UI Preview:
👉 View Screenshots (Images.md)

A Laravel 12 + Inertia.js + Vue 3 multi-tenancy starter kit designed for building SaaS applications with a clean, scalable architecture.
This project provides a solid foundation for central + tenant based apps, modern frontend tooling, and automated developer workflows.

✨ Features

🏗️ Laravel 12 modern architecture

🏢 Multi-Tenancy (Central + Tenant separation)

🔄 Inertia.js + Vue 3 SPA experience

🧩 TypeScript support

⚡ Vite + HMR fast development

🎨 Tailwind CSS v4 UI styling

🧱 shadcn-vue preconfigured component system

🗂️ Clean & scalable folder structure

🔐 Central & Tenant authentication

🛣️ Dedicated tenant routing

📬 Queue & Jobs support

🧪 Testing ready (Feature & Unit)

🧹 Laravel Pint (PHP formatting)

📏 ESLint & Prettier (Frontend linting)

🧠 Developer-friendly scripts

🔁 One-command setup & dev

🌐 SSR support (optional)

🚀 Production-ready boilerplate

📦 Requirements

Make sure the following are installed on your system:

• PHP >= 8.2
• Composer
• Node.js >= 18
• NPM
• MySQL or SQLite
  (SQLite is supported by default for local development)

🚀 Installation

composer create-project erag/laravel-tenancy-vue-starter-kit laravel-multi-tenancy-vue

Run the setup command:

composer run setup

What does this command do?

• Installs Composer dependencies
• Creates .env file (if not exists)
• Generates application key
• Runs database migrations
• Installs NPM dependencies
• Builds frontend assets

🧑‍💻 Development Mode

Start the local development environment:

composer run dev

What runs in development mode?

• Laravel development server
• Queue worker
• Laravel Pail logs
• Vite dev server (HMR)

All processes run together using concurrently.

🌐 SSR Development (Optional)

If you are using Inertia SSR:

composer run dev:ssr

🧪 Testing

Run all tests using:

composer run test

🧹 Linting & Formatting

Linting and formatting are fully automated.

✅ Recommended (One command)

composer run lint

This command will:

• Format & lint PHP using Laravel Pint
• Lint JavaScript / TypeScript using ESLint
• Format Vue & Blade files using Prettier
• Auto-fix issues where possible

You don’t need to run separate npm commands manually.

🔧 Optional Manual Commands

Frontend lint only:

npm run lint

Auto-fix frontend issues:

npm run lint:fix

🧠 Recommendation

Always run this before committing code:

composer run lint

This ensures:

• Clean commits
• Consistent code style
• Fewer CI issues

🔄 Upgrade / Dependency Updates

To update project dependencies:

composer run update:requirements

This will:

• Update Composer dependencies
• Update NPM packages
• Keep version constraints clean

After upgrading, run:

composer install
npm install
npm run build

📁 Project Structure

This project follows a clean and scalable multi-tenancy architecture.

.
├── app
│   ├── Http
│   │   ├── Controllers
│   │   ├── Middleware
│   │   └── Requests
│   ├── Jobs
│   │   └── SyncTenantJob.php
│   ├── Menu
│   │   └── Sidebar.php
│   ├── Models
│   │   ├── Tenant.php
│   │   └── User.php
│   └── Providers
│       ├── CentralRouteServiceProvider.php
│       └── TenancyServiceProvider.php
│
├── config
│   └── tenancy.php
│
├── database
│   ├── migrations
│   │   ├── create_tenants_table.php
│   │   ├── create_domains_table.php
│   │   └── tenant/
│   └── seeders
│
├── resources
│   ├── css
│   ├── js
│   │   ├── app.ts
│   │   ├── components
│   │   ├── composables
│   │   ├── layouts
│   │   ├── pages
│   │   │   ├── tenant
│   │   │   └── auth
│   │   └── types
│   └── views
│       └── app.blade.php
│
├── routes
│   ├── web.php
│   ├── tenant.php
│   └── tenants
│       ├── tenant-auth.php
│       └── tenant-settings.php
│
├── tests
│   ├── Feature
│   └── Unit
│
├── vite.config.ts
├── tsconfig.json
├── composer.json
└── README.md

📂 Ignored from Structure

These directories are intentionally excluded from structure views:

• node_modules/
• vendor/
• storage/
• bootstrap/cache/

🛠 Tech Stack

• Laravel 12
• Inertia.js
• Vue 3
• TypeScript
• Vite
• Tailwind CSS
• Laravel Pint
• ESLint
• Prettier

⭐ Support

If you find this project helpful, please consider giving it a ⭐ on GitHub. It helps the project grow and stay maintained ❤️

🤝 Contributing

Issues and pull requests are welcome. Please ensure code style rules are followed by running lint checks before committing.