generated from Luis/nextjs-python-web-template
Added docker file. Improved Documentation
This commit is contained in:
@@ -1,5 +1,25 @@
|
||||
# cLan - awesome UI
|
||||
|
||||
The files in `src/api` are autogenerated from the openapi.json. The openapi.json comes from the backend, from fastapi which autogenerates the openapi.json file from the python code.
|
||||
|
||||
We then use orval to generate typescript files to `src/api`
|
||||
|
||||
## Build Development Web UI
|
||||
|
||||
To build the dev web ui with hotreloading
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
|
||||
## Build release Web UI
|
||||
|
||||
To build the release version execute
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
## Updating dependencies
|
||||
|
||||
After changing dependencies with
|
||||
@@ -16,14 +36,6 @@ To sort classnames manually:
|
||||
|
||||
`cd /clan-core/pkgs/ui/`
|
||||
|
||||
## Upload ui to gitea
|
||||
## Troubleshooting
|
||||
|
||||
Create a gitea token here: https://git.clan.lol/user/settings/applications
|
||||
|
||||
Than run this command:
|
||||
|
||||
```
|
||||
GITEA_TOKEN=<YOUR_TOKEN> nix run .#update-ui-assets
|
||||
```
|
||||
|
||||
.
|
||||
Sometimes new endpoints don't appear in `src/api`. Delete the `ui/openapi.json` file and execute `direnv reload`
|
||||
|
||||
Reference in New Issue
Block a user