Skip to content

Commit

Permalink
added additional information for the overview
Browse files Browse the repository at this point in the history
  • Loading branch information
benne238 committed Mar 29, 2021
1 parent cf7ebff commit f3b9d67
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/webqueue2 backend overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,9 @@ In order to function, the backend of Webqueue2 relies primarily on two scripts,
### ECNQueue.py
The `ECNQueue.py` script does all of the data and information parsing.

Items are currently stored in plain text within text files and all updates to those items are documented directly into those textfiles via the `qcli`. The `ECNQueue.py` script parses these text files and stores all the information regarding the item into a custom `Item` object.
Items are currently stored in plain text within text files and all updates to those items are documented directly into those textfiles via the `qcli`. The `ECNQueue.py` script parses these text files and stores all the information regarding the item into a custom `Item` object.

### api.py
The `api.py` script does all of the interaction between the front end and the `ECNQueue.py` script.

The front end makes requests, which are then routed to the `api.py` script, which are translated to functions within the `ECNQueue.py`. The json that the `ECNQueue.py` script returns is then returned to the `api.py` script which then routes the json to the frontend.

0 comments on commit f3b9d67

Please sign in to comment.