IoSL/service-aware-frontend
3
0
Fork 0
generated from Luis/nextjs-python-web-template
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improved links to API doc in README #64

Merged
Luis merged 1 commits from Qubasa-main into main 2024-01-24 17:04:07 +00:00
Conversation 0 Commits 1 Files Changed 1 +12 -6
1 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
pkgs/clan-cli/README.md
View File

@@ -1,4 +1,4 @@
# clan-cli # Starting The Backend
The clan-cli contains the command line interface as well as the graphical webui through the `clan webui` command. The clan-cli contains the command line interface as well as the graphical webui through the `clan webui` command.
@@ -13,6 +13,17 @@ clan webui --reload --no-open --log-level debug --populate --emulate
- The `--emulate` flag will automatically run servers the database with dummy data for the fronted to communicate with (ap, dlg, c1 and c2) - The `--emulate` flag will automatically run servers the database with dummy data for the fronted to communicate with (ap, dlg, c1 and c2)
- To look into the emulated endpoints go to http://localhost:2979/emulate - To look into the emulated endpoints go to http://localhost:2979/emulate
# API Documentation
Api documentation can be found in the folder `pkgs/clan-cli/tests/openapi_client/docs/`
For Entity object go to
- [tests/openapi_client/docs/EntitiesApi.md](tests/openapi_client/docs/EntitiesApi.md)
- [tests/openapi_client/docs/EventmessagesApi.md](tests/openapi_client/docs/EventmessagesApi.md)
- [tests/openapi_client/docs/ServicesApi.md](tests/openapi_client/docs/ServicesApi.md)
- [tests/openapi_client/docs/ResolutionApi.md](tests/openapi_client/docs/ResolutionApi.md)
- [tests/openapi_client/docs/RepositoriesApi.md](tests/openapi_client/docs/RepositoriesApi.md)
# Building a Docker Image # Building a Docker Image
To build a docker image of the frontend and backend be inside the `pkgs/clan-cli` folder and execute: To build a docker image of the frontend and backend be inside the `pkgs/clan-cli` folder and execute:
@@ -197,11 +208,6 @@ Runtime dependency add them into this array:
The development environment created by `nix develop` or automatically by `direnv` is located at [shell.nix](shell.nix). The `shellHook` variable execute bash code. The development environment created by `nix develop` or automatically by `direnv` is located at [shell.nix](shell.nix). The `shellHook` variable execute bash code.
# API Documentation
Api documentation can be found in the folder `pkgs/clan-cli/tests/openapi_client/docs/`
For Entity object go to [tests/openapi_client/docs/EntityCreate.md](tests/openapi_client/docs/EntityCreate.md)
# Debugging # Debugging
When working on the backend of your project, debugging is an essential part of the development process. Here are some methods for debugging and testing the backend of your application: When working on the backend of your project, debugging is an essential part of the development process. Here are some methods for debugging and testing the backend of your application: