Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/foxws/laravel-multidomain
Laravel extension for a multi domain/tenant setting
https://github.com/foxws/laravel-multidomain
ddd domain domain-driven-design laravel tenant
Last synced: 6 days ago
JSON representation
Laravel extension for a multi domain/tenant setting
- Host: GitHub
- URL: https://github.com/foxws/laravel-multidomain
- Owner: foxws
- License: mit
- Created: 2022-08-14T20:19:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-03T18:36:55.000Z (over 1 year ago)
- Last Synced: 2023-07-28T08:38:06.261Z (over 1 year ago)
- Topics: ddd, domain, domain-driven-design, laravel, tenant
- Language: PHP
- Homepage:
- Size: 76.2 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# A Laravel extension for a multi domain/tenant setting
[](https://packagist.org/packages/foxws/laravel-multidomain)
[](https://github.com/foxws/laravel-multidomain/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/foxws/laravel-multidomain/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/foxws/laravel-multidomain)
## Description
This package allows a single Laravel application to work with multiple domains/tenants.
It is intended to complement a multi-tenancy package such as [spatie/laravel-multitenancy](https://github.com/spatie/laravel-multitenancy) (tested), [archtechx/tenancy](https://github.com/archtechx/tenancy), etc.
It allows caching of configs, routes & views, and is made to be easy to install, as there is no need to modify the core of the Laravel Framework.
> **TIP:** See [foxws/laravel-multidomain-demo](https://github.com/foxws/laravel-multidomain-demo) for a boilerplate.
## Installation
Install the package via composer:
```bash
composer require foxws/laravel-multidomain
```
Publish the config file with:
```bash
php artisan vendor:publish --tag="multidomain-config"
```
To prevent domain abuse, register the provided middlewares:
```php
protected $middlewareGroups = [
'web' => [
// ...
\Foxws\MultiDomain\Middlewares\NeedsDomain::class,
\Foxws\MultiDomain\Middlewares\EnsureValidDomainSession::class,
]
];
```
## Usage
The package will scan any subfolder (as in domain) located in `app\Domain` (customisable namespace) containing a `domain.json` file.
e.g. `app\Domain\Example\domain.json`:
```json
{
"name": "Example",
"domain": {
"local": "example.test",
"staging": "example.dev",
"production": "example.com"
}
}
```
> **NOTE:** The `domain` array matches the environment set in `.env`, e.g. `APP_ENV=local` will use `example.test` as it's (routing) base. The `name` is converted to a (slug) prefix and is to be used for registering components, routes, views, etc.
The structure of each domain should look like this, using `app\Domain\Example` as it's root path:
| Path | Description | Cacheable |
| ---------------------- | ---------------------------------------- | --------- |
| Routes\web.php | The domain web routes. | ✅ |
| Routes\api.php | The domain api routes. | ✅ |
| Config\\\*.php | The domain config files. | ✅ |
| Providers | The domain providers (optional). | |
| Resources\Components | The domain Blade components (optional). | ✅ |
| Resources\Translations | The domain translation files (optional). | |
| Resources\Views | The domain Blade views (optional). | ✅ |
It will register each config, routes, views, components, using the domain's namespace in slug, e.g. `example`, `foo-bar`.
To interact with the domain(s), one may use the following:
| Helper | Description |
| ------------------------------- | ------------------------------------------------------- |
| `config('example.app.name')` | Would return the name of the application. |
| `route('example.home')` | Would return the route to `/`. |
| `view('example::home')` | Would return the `home.blade.php` located in views. |
| `` | Would return the `MenuComponent` located in components. |
When you have installed `livewire/livewire`, use the following helpers:
| Helper | Description |
| ------------------------------------- | ----------------------------------------------------- |
| `@livewire('example.component-name')` | @livewire blade directive. |
| `` |