diff options
| author | Georgios Andreadis <info@gandreadis.com> | 2020-06-30 14:25:01 +0200 |
|---|---|---|
| committer | Fabian Mastenbroek <mail.fabianm@gmail.com> | 2020-08-24 19:43:17 +0200 |
| commit | 4c8a21da65e9a02437c03dcdb8aab6b054b651b0 (patch) | |
| tree | d47b9bee07dc426e8a70ec9ab215ed59ec2ef599 /web-server/README.md | |
| parent | 2662c23a63c152946bb6b258bac0221ae281ae47 (diff) | |
Consistencify structure
Diffstat (limited to 'web-server/README.md')
| -rw-r--r-- | web-server/README.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/web-server/README.md b/web-server/README.md index 04146f59..6c07c29f 100644 --- a/web-server/README.md +++ b/web-server/README.md @@ -1,5 +1,5 @@ <h1 align="center"> - <img src="images/logo.png" width="100" alt="OpenDC"> + <img src="../misc/artwork/logo.png" width="100" alt="OpenDC"> <br> OpenDC Web Server </h1> @@ -7,7 +7,7 @@ Collaborative Datacenter Simulation and Exploration for Everybody </p> -The OpenDC web server is the bridge between OpenDC's frontend and database. It is built with Flask/SocketIO in Python and implements the OpenAPI-compliant [OpenDC API specification](https://github.com/atlarge-research/opendc/blob/master/opendc-api-spec.json). +The OpenDC web server is the bridge between OpenDC's frontend and database. It is built with Flask/SocketIO in Python and implements the OpenAPI-compliant [OpenDC API specification](../opendc-api-spec.yml). This document explains a high-level view of the web server architecture ([jump](#architecture)), and describes how to set up the web server for local development ([jump](#setup-for-local-development)). @@ -15,7 +15,7 @@ This document explains a high-level view of the web server architecture ([jump]( The following diagram shows a high-level view of the architecture of the OpenDC web server. Squared-off colored boxes indicate packages (colors become more saturated as packages are nested); rounded-off boxes indicate individual components; dotted lines indicate control flow; and solid lines indicate data flow. - + The OpenDC API is implemented by the `Main Server Loop`, which is the only component in the base package. @@ -23,7 +23,7 @@ The OpenDC API is implemented by the `Main Server Loop`, which is the only compo The `Util` package handles several miscellaneous tasks: -* `REST`: Parses SockerIO messages into `Request` objects, and calls the appropriate `API` endpoint to get a `Response` object to return to the `Main Server Loop`. +* `REST`: Parses SocketIO messages into `Request` objects, and calls the appropriate `API` endpoint to get a `Response` object to return to the `Main Server Loop`. * `Param Checker`: Recursively checks whether required `Request` parameters are present and correctly typed. * `Exceptions`: Holds definitions for exceptions used throughout the web server. * `Database API`: Wraps SQLite functionality used by `Models` to read themselves from/ write themselves into the database. |