summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLeon Overweel <l.overweel@gmail.com>2017-03-20 12:57:52 +0100
committerGitHub <noreply@github.com>2017-03-20 12:57:52 +0100
commit0af8947012f378f96710f2941e319b2a9ff3506f (patch)
tree5434b2ee652fe41ade880b0a276d470590491c98 /README.md
parent1843fae39ce7ceed21da6a95ebf5c0ec11f3b4aa (diff)
Add component diagram to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 20e12661..09dbe1b5 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,12 @@
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).
+## Architecture
+
+The following diagram shows a high-level view of the architecture of the OpenDC web server.
+
+![OpenDC Web Server Component Diagram](https://raw.githubusercontent.com/atlarge-research/opendc-web-server/master/images/opendc-web-server-component-diagram.png)
+
## Setup
The following steps will guide you through setting up the OpenDC web server locally for development. To test individual endpoints, edit `static/index.html`. This guide was tested and developed on Windows 10.