PHPackages                             weswecan/nativephp-starter-kit - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. weswecan/nativephp-starter-kit

ActiveProject[Utility & Helpers](/categories/utility)

weswecan/nativephp-starter-kit
==============================

Starterkit for NativePHP projects using inertia, typescript, sass, vue 3, and NativePHP Mobile

03PHP

Since Apr 2Pushed 1mo agoCompare

[ Source](https://github.com/WesWeCan/nativephp-starter-kit)[ Packagist](https://packagist.org/packages/weswecan/nativephp-starter-kit)[ RSS](/packages/weswecan-nativephp-starter-kit/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

NativePHP Mobile Starter Kit
----------------------------

[](#nativephp-mobile-starter-kit)

A Laravel 12 starter kit configured for building native iOS and Android applications using NativePHP Mobile, with Vue 3 + Inertia, TypeScript, Ziggy route helpers, axios, and SCSS via Vite.

### Stack

[](#stack)

- **Backend**: Laravel 12, Inertia Laravel adapter v2
- **Mobile**: NativePHP Mobile v3.0
- **Frontend**: Vue 3 with **script setup** and **TypeScript**
- **Bundler**: Vite 7 + `laravel-vite-plugin` + `nativephpMobile` plugin
- **Dev tools**: `vite-plugin-vue-devtools`
- **Routing helpers**: Ziggy v2 (`@routes` in Blade, `ZiggyVue` in Vue)
- **HTTP**: Axios pre-configured in `bootstrap.ts`
- **Styles**: SCSS (global styles only; no styles inside SFCs)
- **Testing**: Pest v4
- **DX**: Laravel Pail (pretty app logs), Laravel Boost, and a queue worker wired in the dev script

### Project layout (key files)

[](#project-layout-key-files)

- `resources/js/app.ts`: Inertia + Vue app bootstrap, imports `../scss/index.scss`, registers `ZiggyVue`
- `resources/js/bootstrap.ts`: axios on `window`, sets `X-Requested-With`
- `resources/js/Pages/*.vue`: Inertia pages (TypeScript SFCs)
- `resources/js/Layouts/BasicLayout.vue`: Base layout with ``
- `resources/scss/index.scss`: global styles (uses `_variables.scss`)
- `resources/views/app.blade.php`: Inertia root, includes `@routes` + `@vite`
- `vite.config.js`: Laravel + Vue + Vue DevTools + NativePHP Mobile plugins
- `tsconfig.json`: strict TS, path aliases (`@/*`, `ziggy-js`)
- `config/nativephp.php`: NativePHP Mobile configuration
- `native`: Custom wrapper script for NativePHP commands (use `./native` instead of `php artisan native`)

### Conventions

[](#conventions)

- **Vue SFCs**: Always `script setup lang="ts"` at the top, then `template`. No `` blocks in SFCs.
- **Styles**: Put styles in `resources/scss/` and import from `app.ts`.
- **Aliases**: Use `@/` for `resources/js` (configured in `tsconfig.json`).
- **Routes**: Use Ziggy's `route()` in Vue (via `ZiggyVue`) and in Blade via `@routes`.
- **Page titles**: Set by Inertia using `VITE_APP_NAME` for suffix.
- **Package manager**: Use Yarn (not npm) for all Node.js operations.

### Prerequisites

[](#prerequisites)

- PHP 8.3+
- Composer
- Node 18+
- Yarn
- **For iOS development**: macOS with Xcode installed
- **For Android development**: Android Studio with Android SDK installed

### Installation

[](#installation)

```
composer install
cp .env.example .env
php artisan key:generate
yarn install
```

#### NativePHP Setup

[](#nativephp-setup)

Before running your app, configure NativePHP in `.env`:

```
NATIVEPHP_APP_ID=com.yourcompany.yourapp
NATIVEPHP_APP_VERSION=DEBUG
NATIVEPHP_APP_VERSION_CODE=1
NATIVEPHP_DEVELOPMENT_TEAM=YOUR_TEAM_ID  # iOS only, optional
```

Then install NativePHP dependencies:

```
php artisan native:install
```

Or use the custom wrapper:

```
./native install
```

### Development Commands

[](#development-commands)

#### Web Development (Browser)

[](#web-development-browser)

**Start development server** (runs Laravel server, queue worker, Pail logs, and Vite):

```
composer run dev
```

**Or run separately**:

```
# Terminal 1: Laravel server
php artisan serve

# Terminal 2: Vite dev server
yarn dev
```

#### Mobile Development (Native Apps)

[](#mobile-development-native-apps)

**Build for iOS**:

```
yarn build:ios
# or
yarn run:ios  # Builds and runs in one command
```

**Build for Android**:

```
yarn build:android
# or
yarn run:android  # Builds and runs in one command
```

**Run on device/emulator** (builds first):

```
php artisan native:run ios
php artisan native:run android
# or use the wrapper
./native run ios
./native run android
```

**Hot reloading** (watches for changes and auto-reloads):

```
yarn watch
# or specify platform
yarn watch:ios
yarn watch:android
# or use artisan directly
php artisan native:watch
php artisan native:watch ios
php artisan native:watch android
```

**Run with watch** (build, deploy, then watch):

```
yarn run:watch:ios
yarn run:watch:android
# or use artisan directly
php artisan native:run --watch ios
php artisan native:run --watch android
```

**Open in Xcode/Android Studio**:

```
php artisan native:open ios
php artisan native:open android
```

**View logs**:

```
php artisan native:tail
```

#### Build Commands

[](#build-commands)

**Web build**:

```
yarn build
```

**Mobile builds** (run before `native:run`):

```
yarn build:ios      # Build assets for iOS
yarn build:android  # Build assets for Android
```

#### Testing

[](#testing)

```
composer test
# or
php artisan test
```

#### Type Checking

[](#type-checking)

**Vue SFC-aware type-check**:

```
yarn dlx vue-tsc --noEmit
```

**Plain TypeScript** (non-SFC):

```
yarn tsc --noEmit
```

### Using Ziggy route helpers

[](#using-ziggy-route-helpers)

- In Blade (already included): `@routes`
- In Vue (globally via `ZiggyVue`):

```
route('index')
route('posts.show', { post: 1 })
```

### NativePHP Mobile Features

[](#nativephp-mobile-features)

This starter kit includes NativePHP Mobile v3.0 configured with:

- **Hot reloading**: Changes to PHP, Vue, and assets are automatically pushed to the device
- **Vite HMR**: Full hot module replacement support for Vue components
- **Platform detection**: Use `System::isIos()` and `System::isAndroid()` in PHP
- **Native APIs**: Access to Camera, Biometrics, Scanner, Dialog, SecureStorage, and more
- **EDGE Components**: Native UI components via Blade (`native:bottom-nav`, `native:top-bar`, etc.)

See the [NativePHP Mobile documentation](https://nativephp.com/docs/mobile/2/) for full API reference.

### Development Tips

[](#development-tips)

1. **Keep `NATIVEPHP_APP_VERSION=DEBUG`** during development to ensure Laravel always refreshes
2. **Use hot reloading** (`native:watch`) for faster iteration - no need to rebuild after every change
3. **Build assets first**: Always run `yarn build:ios` or `yarn build:android` before `native:run`
4. **Real devices**: Hot reloading works on real devices if they're on the same Wi-Fi network
5. **iOS limitations**: Full hot reloading on real iOS devices has some limitations (works best on simulators)

### Notes

[](#notes)

- Axios is available as `window.axios` with `X-Requested-With` set.
- The Inertia progress bar is enabled with a gray color.
- `assetsInclude: ['**/*.glsl']` is enabled in Vite if you import GLSL assets.
- The `native` wrapper script allows shorter commands: `./native run ios` instead of `php artisan native:run ios`
- Composer `dev` script uses Yarn internally (not npm)

### What's included vs. not

[](#whats-included-vs-not)

- **Included**: Vue 3 + TS, Inertia v2, Ziggy v2, SCSS, Axios, Vite, Vue DevTools, Pest v4, Pail, queue worker in dev, NativePHP Mobile v3.0, Laravel Boost
- **Not included**: SSR, authentication scaffolding, ESLint/Prettier config

### Resources

[](#resources)

- [NativePHP Mobile Documentation](https://nativephp.com/docs/mobile/2/)
- [Laravel 12 Documentation](https://laravel.com/docs/12.x)
- [Inertia.js Documentation](https://inertiajs.com/)
- [Vue 3 Documentation](https://vuejs.org/)

###  Health Score

20

—

LowBetter than 14% of packages

Maintenance61

Regular maintenance activity

Popularity3

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity11

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/bf1d44678173e63468c9abca09a7e329a773a522a17e7370d3e0a9812a16daea?d=identicon)[WesWeCan](/maintainers/WesWeCan)

---

Top Contributors

[![WesWeCan](https://avatars.githubusercontent.com/u/79587028?v=4)](https://github.com/WesWeCan "WesWeCan (5 commits)")

### Embed Badge

![Health badge](/badges/weswecan-nativephp-starter-kit/health.svg)

```
[![Health](https://phpackages.com/badges/weswecan-nativephp-starter-kit/health.svg)](https://phpackages.com/packages/weswecan-nativephp-starter-kit)
```

###  Alternatives

[dan-da/coinparams

provides crypto currency specific information such as version numbers, DNS seeds, etc, available in JSON format

3551.9k5](/packages/dan-da-coinparams)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)