Added README file

This commit is contained in:
Ivan Gromov 2022-08-31 00:23:04 +05:00 committed by Ivan Gromov
parent 15b0d1f094
commit 76cb02b720
2 changed files with 41 additions and 1 deletions

39
app/README.md Normal file
View file

@ -0,0 +1,39 @@
# Algo web app UI
## Abstract
[A short description of what project does]
## Background
VUE docs,
asyncio docs
## Rationale
Why A not B
(vue is modern and doesn't require build system and depoendency)
asyncio - same
PBEX is patched because shell access considered insecure
## Implementation
app/server.py management, threading
config yaml writer
generic approach to provider UI (set required fields, validation, inherit ENV, try to detect)
how progress displayed
## testing
testing js: vue-test-library + loader
testing python: pytests
testing pbex compatibility: demo yaml
## Compatibility (if applicable)
[A discussion of the change with regard to the compatibility.]
Due to ansible doesn't have API, have to manually check if custom PBEX would still work
## Open issues (if applicable)
Still requires pip install, consider py2exe, pyinstaller
No task progress displayed, require callback module

View file

@ -1 +1,2 @@
aiohttp==3.6.2
aiohttp==3.6.2
boto3