quick-start.md

title	Quick Start
order	2

Jump in

Don't waste hours downloading, installing, and configuring Xcode and Android Studio; just Jump:

1. Install the Jump app on your iOS or Android device
2. Run the following commands:

New Laravel app

If you are creating new Laravel app, you can build using our starter kit:

laravel new my-app --using=nativephp/mobile-starter

cd my-app

php artisan native:jump

Existing Laravel app

If you already have a Laravel app:

composer require nativephp/mobile

php artisan native:jump

Scan the QR code with Jump and you're off!

Install & run

If you've already got your environment set up to build mobile apps using Xcode and/or Android Studio, you can build and run your app locally:

# Install NativePHP for Mobile into a new Laravel app
composer require nativephp/mobile

# Ready your app to go native
php artisan native:install

# Run your app on a mobile device
php artisan native:run

The native command

When you run native:install, NativePHP installs a native script helper that can be used as a convenient wrapper to the native Artisan command namespace. Once this is installed you can do the following:

# Instead of...
php artisan native:run

# Do
php native run

# Or
./native run

Need help?

• Community - Join our Discord for support and discussions.
• Examples - Check out the Kitchen Sink demo app on Android and iOS!