summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLeon Overweel <l.overweel@gmail.com>2017-03-20 13:33:14 +0100
committerGitHub <noreply@github.com>2017-03-20 13:33:14 +0100
commitbdb4b16c91263e7a82409d082d213e3191728c72 (patch)
treebcc25ce7410599b241c28fe96e2d57a15e21cbcd /README.md
parent0af8947012f378f96710f2941e319b2a9ff3506f (diff)
Move architecture below setup in README
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 7 insertions, 5 deletions
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)