generated from Luis/nextjs-python-web-template
readmes added comments and some links to the openapi docs mds :)
This commit is contained in:
37
pkgs/clan-cli/clan_cli/README.md
Normal file
37
pkgs/clan-cli/clan_cli/README.md
Normal file
@@ -0,0 +1,37 @@
|
||||
**init\_**.py:
|
||||
|
||||
```bash
|
||||
usage: clan webui [-h] [--port PORT] [--host HOST] [--populate] [--emulate] [--no-open] [--dev]
|
||||
[--dev-port DEV_PORT] [--dev-host DEV_HOST] [--reload]
|
||||
[--log-level {critical,error,warning,info,debug,trace}]
|
||||
[sub_url]
|
||||
|
||||
positional arguments:
|
||||
sub_url Sub URL to open in the browser
|
||||
|
||||
options:
|
||||
-h, --help show this help message and exit
|
||||
--port PORT Port to listen on
|
||||
--host HOST Host to listen on
|
||||
--populate Populate the database with dummy data
|
||||
--emulate Emulate two entities c1 and c2 + dlg and ap
|
||||
--no-open Don't open the browser
|
||||
--dev Run in development mode
|
||||
--dev-port DEV_PORT Port to listen on for the dev server
|
||||
--dev-host DEV_HOST Host to listen on
|
||||
--reload Don't reload on changes
|
||||
--log-level {critical,error,warning,info,debug,trace}
|
||||
Log level
|
||||
```
|
||||
|
||||
In this folder are some basic files:
|
||||
|
||||
- config.py
|
||||
- to configer basic value for the server and the emulation
|
||||
- ip/host
|
||||
- ports
|
||||
- emuplate_fast.py
|
||||
- some api call that emulate the behavoir
|
||||
- extra servers with api calls are emulated here
|
||||
|
||||
In the subfolder <webui> is the backend impplemented.
|
||||
Reference in New Issue
Block a user