From 0af8947012f378f96710f2941e319b2a9ff3506f Mon Sep 17 00:00:00 2001 From: Leon Overweel Date: Mon, 20 Mar 2017 12:57:52 +0100 Subject: Add component diagram to README --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'README.md') 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. -- cgit v1.2.3