Add pwa readme
This commit is contained in:
parent
2b5b957a58
commit
83362a6511
|
@ -187,7 +187,7 @@ release a new version, simply:
|
|||
1. [Update project version](#updating-the-version)
|
||||
2. Commit and push.
|
||||
3. Run the
|
||||
[`Publish Release`](https://github.com/padloc/padloc/actions?workflow=Publish+Release)
|
||||
[Publish Release](https://github.com/padloc/padloc/actions?workflow=Publish+Release)
|
||||
action.
|
||||
|
||||
## Licensing
|
||||
|
|
|
@ -0,0 +1,67 @@
|
|||
# @padloc/pwa
|
||||
|
||||
The Padloc Web Client, a
|
||||
[Progressive Web App](https://developers.google.com/web/progressive-web-apps).
|
||||
|
||||
## Setup
|
||||
|
||||
Currently the `@padloc/pwa` package is meant to be used from within the
|
||||
[Padloc monorepo](../../README.md). A standalone npm package is coming soon!
|
||||
|
||||
```sh
|
||||
git clone git@github.com:padloc/padloc.git
|
||||
cd padloc
|
||||
npm ci
|
||||
cd packages/pwa
|
||||
```
|
||||
|
||||
## Building
|
||||
|
||||
To build the pwa, simply run the following from within the package directory.
|
||||
|
||||
```sh
|
||||
npm run build
|
||||
```
|
||||
|
||||
### Build options
|
||||
|
||||
All build options are provided as environment variables:
|
||||
|
||||
| Variable Name | Description | Default |
|
||||
| --------------- | -------------------------------------------------- | -------- |
|
||||
| `PL_SERVER_URL` | URL to the [server component](../server/README.md) | `./dist` |
|
||||
| `PL_PWA_DIR` | Build output directory | `./dist` |
|
||||
| `PL_DISABLE_SW` | Disable web worker | `./dist` |
|
||||
|
||||
## Web Server
|
||||
|
||||
This package also has a bundled web server, which can be used to serve the web
|
||||
app:
|
||||
|
||||
```sh
|
||||
npm run start
|
||||
```
|
||||
|
||||
By default the app ist hosted on port `3000`. To change the port, you can use
|
||||
the `PL_PWA_PORT` environment variable:
|
||||
|
||||
```sh
|
||||
PL_PWA_PORT=8081 npm run start
|
||||
```
|
||||
|
||||
Note that this requires the PWA to be [built](#building) first. To build and
|
||||
serve the app in one step, run:
|
||||
|
||||
```sh
|
||||
npm run build_and_start
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
For development instructions, please refer to the
|
||||
[monorepo readme](../../README.md#development).
|
||||
|
||||
## Contributing
|
||||
|
||||
For info on how to contribute to Padloc, please refer to the
|
||||
[monorepo readme](../../README.md#contributing).
|
|
@ -116,6 +116,10 @@ a [`sample .env file`](resources/example.env). Simply copy the file to wherever
|
|||
you want to keep it and the uncomment and edit any options you want to set (more
|
||||
info about the most important configuration options below).
|
||||
|
||||
### General Server Options
|
||||
|
||||
TBD
|
||||
|
||||
### Data Transport
|
||||
|
||||
TBD
|
||||
|
@ -140,9 +144,15 @@ TBD
|
|||
|
||||
TBD
|
||||
|
||||
### General Server Options
|
||||
## Development
|
||||
|
||||
TBD
|
||||
For development instructions, please refer to the
|
||||
[monorepo readme](../../README.md#development).
|
||||
|
||||
## Contributing
|
||||
|
||||
For info on how to contribute to Padloc, please refer to the
|
||||
[monorepo readme](../../README.md#contributing).
|
||||
|
||||
## Licensing
|
||||
|
||||
|
|
Loading…
Reference in New Issue