From bdb4b16c91263e7a82409d082d213e3191728c72 Mon Sep 17 00:00:00 2001 From: Leon Overweel Date: Mon, 20 Mar 2017 13:33:14 +0100 Subject: Move architecture below setup in README --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 09dbe1b5..41c78f6d 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,7 @@ 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) +This document describes how to set up the web server for local development, and explains a high-level view of the web server architecture. ## Setup @@ -52,3 +48,9 @@ Run the server. ```bash python opendc-web-server/main.py config.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) -- cgit v1.2.3