Skip to content

Commit e814ed7

Browse files
committed
Update readme + client generator
1 parent a90ff64 commit e814ed7

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

build-clients.sh

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#!/bin/bash
2+
set -e
3+
4+
echo "Generating typescript client..."
5+
6+
cd typescript-client
7+
sh ./build.sh
8+
9+
echo "Typescript client generated!"

console/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,19 @@ npm run build
3636
You can preview the production build with `npm run preview`.
3737

3838
> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
39+
40+
41+
### Using the Frontends
42+
43+
Both frontends rely on an autogenerated typescript-client. This client is generated using the OpenAPI specification, also generated from Nest Swagger module.
44+
45+
To generate the client, run the following command from the root of the project:
46+
47+
```bash
48+
sh build-clients.sh
49+
```
50+
51+
This will generate the client in the `console/src/lib/gen-api` folder.
52+
53+
This folder is .gitignored, be sure to not commit it.
54+

0 commit comments

Comments
 (0)