padloc/packages/pwa/README.md

@padloc/pwa

The Padloc Web Client, a Progressive Web App.

Setup

Currently the @padloc/pwa package is meant to be used from within the Padloc monorepo. A standalone npm package is coming soon!

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.

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	./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:

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:

PL_PWA_PORT=8081 npm run start

Note that this requires the PWA to be built first. To build and serve the app in one step, run:

npm run build_and_start

Development

For development instructions, please refer to the monorepo readme.

Contributing

For info on how to contribute to Padloc, please refer to the monorepo readme.