diff options
| author | Leon Overweel <l.overweel@gmail.com> | 2017-03-12 18:27:14 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-03-12 18:27:14 +0100 |
| commit | 9d16ac4a196d12b016bbc08483aa883af841a8ad (patch) | |
| tree | 65c3cbebd7ec90af6c88aa322dc063d33440cd5d /README.md | |
| parent | ace25f0382c20b0e79afa85227dc155b5498a1dc (diff) | |
Add introduction to README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 4 |
1 files changed, 3 insertions, 1 deletions
@@ -1,5 +1,7 @@ # OpenDC Web Server +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/tudelft-atlarge/opendc/blob/master/opendc-api-spec.json). + ## 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. @@ -43,4 +45,4 @@ Run the server. ```bash python opendc-web-server/main.py config.json -```
\ No newline at end of file +``` |