Skip to content

Document Vite plugin auto-configuration during native:install #270

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
benjam-es wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document Vite plugin auto-configuration during native:install #270

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions resources/views/docs/mobile/3/getting-started/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,14 @@ To facilitate ease of development, you should install the `nativephpMobile` Vite

### The `nativephpMobile` Vite plugin

To make your frontend build process works well with NativePHP, simply add the `nativephpMobile` plugin to your
`vite.config.js`:
If you're using an Inertia (React or Vue) starter kit, `php artisan native:install` will offer to configure this for
you automatically. You can also skip the prompt by passing the `--with-vite` flag:

```shell
php artisan native:install --with-vite
```

If you need to set it up manually, add the `nativephpMobile` plugin to your `vite.config.js`:

```js
import { nativephpMobile, nativephpHotFile } from './vendor/nativephp/mobile/resources/js/vite-plugin.js'; // [tl! focus]
Expand Down
5 changes: 5 additions & 0 deletions resources/views/docs/mobile/3/getting-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,11 @@ php artisan native:install

The NativePHP installer takes care of setting up and configuring your Laravel application to work with iOS and Android.

If you're using an Inertia starter kit (React or Vue), the installer will offer to automatically configure the
[`nativephpMobile` Vite plugin](/docs/getting-started/development#the-codenativephpmobilecode-vite-plugin) in your
`vite.config.js`. This is required for HMR and correct asset loading on iOS. You can also pass `--with-vite` to skip
the prompt.

You may be prompted about whether you would like to install the ICU-enabled PHP binaries. You should install these if
your application relies on the `intl` PHP extension.

Expand Down