open-southeners / laravel-companion-apps
Extend your Laravel applications with companions apps (Android, iOS, PWA...)
Fund package maintenance!
open-southeners
Requires
- php: ^8.1
- chillerlan/php-qrcode: ^5.0
- illuminate/support: ^10.0 || ^11.0
- jenssegers/agent: ^2.6
- laravel/prompts: ^0.1
Requires (Dev)
- larastan/larastan: ^2.0
- laravel/facade-documenter: dev-main
- orchestra/testbench: ^8.0 || ^9.0
- phpstan/phpstan: ^1.0
- phpunit/phpunit: ^10.0
README
Extend your Laravel applications with companions apps (Android, Apple, Progressive Web Applications...).
Key features
- Allow app links (also called deep links) on Android apps:
- Generates the
.well-known/assetlinks.json
file for app links verification - Redirects to app links (
redirect()->toApp(Companion::android('com.my_company.my_app'), 'products/1')
orCompanion::android('com.my_company.my_app')->redirect('products/1')
) - Generates app links (
Companion::android('com.my_company.my_app')->link('products/1')
)
- Generates the
- Allow app links (also called universal links) on iOS apps:
- Generates the
apple-app-site-association
file for app links verification - Redirects to app links (
redirect()->toApp(Companion::ios('com.my_company.my_app'))
orCompanion::ios('com.my_company.my_app')->redirect('products/1')
) - Generates app links (
Companion::ios('com.my_company.my_app')->link('products/1')->fallbackToStore()
)
- Generates the
- Add smart banner (Apple only for now) using Blade directive
@companionMetaTags
or facade's methodapp('companion')->metaTags()
Getting started
composer require open-southeners/laravel-companion-apps
Documentation
To learn how to use everything you should check the official documentation.
Partners
License
This package is open-sourced software licensed under the MIT license.