From 4c8a21da65e9a02437c03dcdb8aab6b054b651b0 Mon Sep 17 00:00:00 2001 From: Georgios Andreadis Date: Tue, 30 Jun 2020 14:25:01 +0200 Subject: Consistencify structure --- web-server/README.md | 8 ++++---- web-server/images/logo.png | Bin 2825 -> 0 bytes .../images/opendc-web-server-component-diagram.png | Bin 90161 -> 0 bytes .../artwork/opendc-web-server-component-diagram.png | Bin 0 -> 90161 bytes 4 files changed, 4 insertions(+), 4 deletions(-) delete mode 100644 web-server/images/logo.png delete mode 100644 web-server/images/opendc-web-server-component-diagram.png create mode 100644 web-server/misc/artwork/opendc-web-server-component-diagram.png (limited to 'web-server') 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 @@

- OpenDC + OpenDC
OpenDC Web Server

@@ -7,7 +7,7 @@ Collaborative Datacenter Simulation and Exploration for Everybody

-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. -![OpenDC Web Server Component Diagram](https://raw.githubusercontent.com/atlarge-research/opendc-web-server/master/images/opendc-web-server-component-diagram.png) +![OpenDC Web Server Component Diagram](misc/artwork/opendc-web-server-component-diagram.png) 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. diff --git a/web-server/images/logo.png b/web-server/images/logo.png deleted file mode 100644 index d743038b..00000000 Binary files a/web-server/images/logo.png and /dev/null differ diff --git a/web-server/images/opendc-web-server-component-diagram.png b/web-server/images/opendc-web-server-component-diagram.png deleted file mode 100644 index 91b26006..00000000 Binary files a/web-server/images/opendc-web-server-component-diagram.png and /dev/null differ diff --git a/web-server/misc/artwork/opendc-web-server-component-diagram.png b/web-server/misc/artwork/opendc-web-server-component-diagram.png new file mode 100644 index 00000000..91b26006 Binary files /dev/null and b/web-server/misc/artwork/opendc-web-server-component-diagram.png differ -- cgit v1.2.3