diff options
Diffstat (limited to 'packages/merchant-backoffice-ui/README.md')
-rw-r--r-- | packages/merchant-backoffice-ui/README.md | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/packages/merchant-backoffice-ui/README.md b/packages/merchant-backoffice-ui/README.md new file mode 100644 index 000000000..34bb98b67 --- /dev/null +++ b/packages/merchant-backoffice-ui/README.md @@ -0,0 +1,64 @@ +## Merchant Admin Frontend + +Merchant Admin Frontend is a Single Page Application (SPA) that connects with a running Merchant Backend and lets you manage instances, orders, products and tipping. + +## System requirements + +- Node: v16.15.0 +- pnpm: 7.14.2 +- make + +## Compiling from source + +Run `pnpm install --frozen-lockfile --filter @gnu-taler/merchant-backoffice...` to install all the nodejs dependencies. + +Then the command `pnpm build` create the distribution in the `dist` folder. + +By default the installation prefix will be `/usr/local/share/taler/merchant-backoffice/` but it can be overridden by `--prefix` in the configuration process: + +```shell +./configure --prefix=/another/directory +``` + +To install run `make install` + +## Running develop + +To run a development server run: + +```shell +./dev.mjs +``` + +This should start a watch process that will reload the server every time that a file is saved. + +The application need to connect to a merchant-backend properly configured to run. + +## Building for deploy + +To build and deploy the SPA in your local server run the install script: + +```shell +make install +``` + +## Runtime dependencies + +* preact: Fast 3kB alternative to React with the same modern API + +* preact-router: URL component router for Preact + +* SWR: React Hooks library for data fetching (stale-while-revalidate) + +* Yup: schema builder for value parsing and validation (to be deprecated) + +* Date-fns: library for manipulating javascript date + +* qrcode-generator: simplest qr implementation based on JIS X 0510:1999 + +* @gnu-taler/taler-util: types and tooling + +* history: manage the history stack, navigate, and persist state between sessions + +* jed: gettext like library for internationalization + |