Building

#Building Your App

Building your app is the process of compiling your application into a production-ready state. When building, NativePHP attempts to sign and notarize your application. Once signed, your app is ready to be distributed.

#Securing

Before you prepare a distributable build, please make sure you've been through the Security guide.

#Building

The build process compiles your app for one platform at a time. It compiles your application along with the Electron/Tauri runtime into a single executable.

Once built, you can distribute your app however you prefer, but NativePHP also provides a publish command that will automatically upload your build artifacts to your chosen provider - this allows your app to provide automatic updates.

You should build your application for each platform you intend to support and test it on each platform before publishing to make sure that everything works as expected.

#Running commands before and after builds

Many applications rely on a tool such as Vite or Webpack to compile their CSS and JS assets before a production build.

To facilitate this, NativePHP provides two hooks that you can use to run commands before and after the build process.

To utilise these hooks, add the following to your config/nativephp.php file:

'prebuild' => [
    'npm run build', // Run a command before the build
    'php artisan optimize', // Run another command before the build
],
'postbuild' => [
    'npm run release', // Run a command after the build
],

These commands will be run in the root of your project directory and you can specify as many as required.

#Versioning

For every build you create, you should change the version of your application in your app's config/nativephp.php file.

This can be any format you choose, but you may find that a simple incrementing build number is the easiest to manage.

Migrations will only run on the user's machine if the version reference is different to the currently-installed version.

You may choose to have a different version number that uses a different scheme (e.g. SemVer) that you use for user-facing releases.

#Running a build

php artisan native:build

This will build for the platform and architecture where you are running the build.

#Cross-compilation

You can also specify a platform to build for by passing the os argument, so for example you could build for Windows whilst on a Mac:

php artisan native:build win

Possible options are: mac, win, linux.

Cross-compilation is not supported on all platforms.

Cross-compilation on Linux

Compiling Windows binaries is possible with wine. NSIS requires 32-bit wine when building x64 applications.

# Example installation of wine for Debian based distributions (Ubuntu)
dpkg --add-architecture i386
apt-get -y update
apt-get -y install wine32

#Code signing

Both macOS and Windows require your app to be signed before it can be distributed to your users.

NativePHP makes this as easy for you as it can, but each platform does have slightly different requirements.

#Windows

See the Electron documentation for more details.

#macOS

See the Electron documentation for more details.

To prepare for signing and notarizing, please provide the following environment variables when running php artisan native:build:

[email protected]
NATIVEPHP_APPLE_ID_PASS=app-specific-password
NATIVEPHP_APPLE_TEAM_ID=8XCUU22SN2

These can be added to your .env file as they will be stripped out when your app is built.

Without proper notarization your app will only run on the development machine. Other Macs will show a "app is damaged and can't be opened" warning. This is a security feature in macOS that prevents running unsigned or improperly notarized applications. Make sure to complete the notarization process to avoid this issue.

#First run

When your application runs for the first time, a number of things occur.

NativePHP will:

1. Create the appdata folder - where this is created depends which platform you're developing on. It is named according to your nativephp.app_id config value (which is based on the NATIVEPHP_APP_ID env variable).
2. Creating the {appdata}/database/database.sqlite SQLite database - your user's copy of your app's database.
3. Migrate this database.

If you wish to seed the user's database, you should run this somewhere that runs every time your app boots.

Check if the database was already seeded and, if not, run the appropriate db:seed command. For example:

use App\Models\Config;
use Illuminate\Support\Facades\Artisan;
 
if (Config::where('seeded', true)->count() === 1) {
    Artisan::call('db:seed');
}

#Subsequent runs

Each time a user opens your app, NativePHP will check to see if the app version has changed and attempt to migrate the user's copy of your database in their appdata folder.

This is why you should change the version identifier for each release.