Skip to content

Commit c6c16bb

Browse files
committed
Improve installation docs
1 parent 33951d4 commit c6c16bb

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

resources/views/docs/1/getting-started/installation.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,34 +27,40 @@ NativePHP is built to work best with Laravel. You can install it into an existin
2727

2828
## Install a NativePHP runtime
2929

30-
```bash
30+
```shell
3131
composer require nativephp/electron
3232
```
3333

3434
The Tauri runtime is coming soon.
3535

3636
## Run the NativePHP installer
3737

38-
```bash
38+
```shell
3939
php artisan native:install
4040
```
4141

4242
The NativePHP installer takes care of publishing the NativePHP service provider, which bootstraps the necessary
43-
dependencies for your application to work with the runtime you're using: Electron or Tauri. It also publishes the
44-
NativePHP configuration file to `config/nativephp.php`.
43+
dependencies for your application to work with the runtime you're using: Electron or Tauri.
44+
45+
It also publishes the NativePHP configuration file to `config/nativephp.php`.
46+
47+
It adds the `composer native:dev` script to your `composer.json`, which you are free to modify to suit your needs.
4548

4649
Finally, it installs any other dependencies needed for the specific runtime you're using, e.g. for Electron it installs
4750
the NPM dependencies.
4851

49-
**Whenever you set up NativePHP on a new machine or in CI, you should run the installer to make sure all of the
52+
**Whenever you set up NativePHP on a new machine or in CI, you should run the installer to make sure all the
5053
necessary dependencies are in place to build your application.**
5154

5255
## Start the development server
5356

54-
```bash
57+
**Heads up!** Before starting your app in a native context, try running it in the browser. You may bump into exceptions
58+
which need addressing before you can run your app natively, and may be trickier to spot when doing so.
59+
60+
Once you're ready:
61+
62+
```shell
5563
php artisan native:serve
5664
```
5765

58-
This spins up a development build of your application for local testing.
59-
60-
And that's it! You should now see your Laravel application running in a native desktop window.
66+
And that's it! You should now see your Laravel application running in a native desktop window. 🎉

0 commit comments

Comments
 (0)