summaryrefslogtreecommitdiff
path: root/packages/auditor-backoffice-ui/README.md
blob: b10fa6a94b7919b7abe6c2c07f24e72f9ecb4677 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
## AUditor Admin Frontend

Auditor Admin Frontend is a Single Page Application (SPA) that connects with a running Auditor Backend and lets you audit the exchange.

## System requirements

- Node: v16.15.0
- pnpm: 7.14.2
- make

## Compiling from source

Run `pnpm install --frozen-lockfile --filter @gnu-taler/auditor-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/auditor-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 auditor-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