update readme

This commit is contained in:
Max Peintner
2023-05-05 16:32:57 +02:00
parent a7c2171156
commit 5473adf0b4
2 changed files with 24 additions and 1 deletions

View File

@@ -28,6 +28,7 @@ This repo has some additional tools:
### Useful commands
- `pnpm generate` - Build proto stubs for server and client package
- `pnpm build` - Build all packages and the login app
- `pnpm dev` - Develop all packages and the login app
- `pnpm lint` - Lint all packages
@@ -63,3 +64,25 @@ See [Working with the npm registry](https://docs.github.com/en/packages/working-
- Buf setup to get grpc stub in the core package
- Decide whether a seperate client package is required to expose public client convenience methods only or generate a grpc-web output there
- Fix #/\* path in login application
### Run Login UI
To run the application make sure to install the dependencies with
```sh
pnpm install
```
then generate the GRPC stubs with
```sh
pnpm generate
```
and then run it with
```sh
pnpm dev
```
The login application with run on `localhost:3000`.