summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGeorgios Andreadis <g.andreadis@student.tudelft.nl>2017-09-25 12:29:48 +0200
committerGeorgios Andreadis <g.andreadis@student.tudelft.nl>2017-09-25 12:29:48 +0200
commit84f817d8bd8b0f1e1e75a84e73cadea0b5d5f966 (patch)
tree5bfffbcd7e2d67e9c91858ea2fdb8b9923482a78 /README.md
parentd8576899f9b82f3d8a84886b586966a233ec0f5f (diff)
Add experimental tool disclaimer to entry page
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/README.md b/README.md
index fe3b3e14..a4ca63a0 100644
--- a/README.md
+++ b/README.md
@@ -35,6 +35,8 @@ To compile everything for camera-ready deployment, use the following command:
yarn build
```
+**Note:** Perhaps this goes without saying, but for any functionality beyond visiting the entry page, a server backend running in the background is necessary. The easiest way to do this is to have an OpenDC docker container running, see [the main repo](https://github.com/atlarge-research/opendc) for more information on how to do this.
+
## Architecture
The codebase follows a standard React.js structure, with static assets being contained in the `public` folder, while dynamic components and their styles are contained in `src`. The app uses client-side routing (with `react-router`), meaning that the only HTML file needed to be served is a `index.html` file.