github.com/pojntfx/hydrapp/hydrapp@v0.0.0-20240516002902-d08759d6ca9f/pkg/generators/README_react_panrpc.md.tpl (about)

     1  # {{ .AppName }}
     2  
     3  {{ .AppSummary }}.
     4  
     5  [![hydrapp CI]({{ .AppGitWeb }}/actions/workflows/hydrapp.yaml/badge.svg)]({{ .AppGitWeb }}/actions/workflows/hydrapp.yaml)
     6  
     7  ## Overview
     8  
     9  {{ .AppDescription }}
    10  
    11  ## Installation
    12  
    13  See [INSTALLATION.html]({{ .AppBaseURL }}/docs/main/INSTALLATION.html).
    14  
    15  ## Reference
    16  
    17  ### Command Line Arguments
    18  
    19  All arguments passed to the binary will be forwarded to the browser used to display the frontend.
    20  
    21  ### Environment Variables
    22  
    23  | Name                     | Description                                                                                                 |
    24  | ------------------------ | ----------------------------------------------------------------------------------------------------------- |
    25  | `HYDRAPP_BACKEND_LADDR`  | Listen address for the backend (`localhost:0` by default)                                                   |
    26  | `HYDRAPP_FRONTEND_LADDR` | Listen address for the frontend (`localhost:0` by default)                                                  |
    27  | `HYDRAPP_BROWSER`        | Binary of browser to display the frontend with                                                              |
    28  | `HYDRAPP_TYPE`           | Type of browser to display the frontend with (one of `chromium`, `firefox`, `epiphany`, `lynx` and `dummy`) |
    29  | `HYDRAPP_SELFUPDATE`     | Whether to check for updates on launch (disabled if OS provides an app update mechanism)                    |
    30  
    31  ## Acknowledgements
    32  
    33  - [pojntfx/hydrapp](https://github.com/pojntfx/hydrapp) provides the application framework.
    34  
    35  ## Contributing
    36  
    37  To contribute, please use the [GitHub flow](https://guides.github.com/introduction/flow/) and follow our [Code of Conduct](./CODE_OF_CONDUCT.md).
    38  
    39  To build and start a development version of {{ .AppName }} locally, run the following:
    40  
    41  ```shell
    42  $ git clone {{ .AppGit }}
    43  $ cd {{ .Dir }}
    44  $ go generate ./...
    45  $ go run .
    46  ```
    47  
    48  To start the backend and open the frontend in a browser instead of an application window during development, run the following:
    49  
    50  ```shell
    51  # Start the backend in the first terminal
    52  $ HYDRAPP_BACKEND_LADDR=localhost:1337 HYDRAPP_TYPE=dummy go run .
    53  # Start the frontend in a second terminal
    54  $ cd pkg/frontend
    55  $ npm run dev
    56  # Now open http://localhost:1234 in your browser
    57  ```
    58  
    59  To build the DEB, RPM, Flatpak, MSI, EXE, DMG, APK, and static binaries for all other platforms, run the following:
    60  
    61  ```shell
    62  $ hydrapp build
    63  # You can find the built packages in the out/ directory
    64  ```
    65  
    66  If you only want to build certain packages or for certain architectures, for example to only build the APKs, pass `--exclude` like in the following:
    67  
    68  ```shell
    69  $ hydrapp build --exclude '(binaries|deb|rpm|flatpak|msi|dmg|docs|tests)'
    70  ```
    71  
    72  For more information, see the [hydrapp documentation](https://github.com/pojntfx/hydrapp).
    73  
    74  ## License
    75  
    76  {{ .AppName }} (c) {{ .CurrentYear }} {{ .ReleaseAuthor }} and contributors
    77  
    78  SPDX-License-Identifier: {{ .LicenseSPDX }}