acdphp/laravel-multitenancy-api-template

Base Laravel framework with multi-tenancy api ready structure.

v2.1.0 2024-01-01 19:09 UTC

Requires

• php: ^8.2
• acdphp/laravel-multitenancy: ^2.1
• acdphp/laravel-schedule-police: ^1.0
• archtechx/enums: ^0.3.2
• guzzlehttp/guzzle: ^7.8
• laravel/framework: ^10.23
• laravel/horizon: ^5.20
• laravel/passport: ^11.9
• league/flysystem-aws-s3-v3: ^3.16

Requires (Dev)

• barryvdh/laravel-ide-helper: ^2.13
• ekino/phpstan-banned-code: ^1.0
• fakerphp/faker: ^1.9.1
• larastan/larastan: ^2.7
• laravel/pint: ^1.0
• laravel/tinker: ^2.8
• mockery/mockery: ^1.4.4
• nunomaduro/collision: ^7.0
• phpstan/phpstan: ^1.10
• phpstan/phpstan-mockery: ^1.1
• phpunit/phpunit: ^10.1
• plannr/laravel-fast-refresh-database: ^1.1
• roave/security-advisories: dev-latest
• spatie/laravel-ignition: ^2.0

MIT

• framework
• api
• laravel
• saas
• multitenancy

README

• Base company class for multi-tenancy using acdphp/laravel-multitenancy.
• Base user authentication class.

Requirements

• Docker compose v2.1 or higher

Pre-configured utilities

• Laravel Multitenancy
• Laravel Horizon
• Laravel Passport
• Laravel Schedule Police

Local docker-compose deployment

1. Copy .env.example to .env

   cp .env.example .env

2. Start

   ./start_local.sh

3. Create oauth password grant client

   docker-compose exec -it api php artisan passport:client --password

4. Seed dummy data (optional)

   docker-compose exec -it api php artisan db:seed

5. Health Check

   curl http://localhost/api/health-check
   
   # Output: {"status":"ok"}

6. Stop

   docker-compose down

Default superadmin user and company

company.name: config('app.name')
email: [e-mail]
password: a_little_harder_password