From 02997b2522b9c66072b16f1425c02e81e0085e3c Mon Sep 17 00:00:00 2001 From: Fabian Mastenbroek Date: Tue, 14 Jul 2020 21:10:56 +0200 Subject: Rename web-server to API This change renames the web-server component to API in order to be more descriptive of its role. The OpenDC API bridges between the frontend on one side and the database and simulator on the other side. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 14156eff..66ffd22d 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ OpenDC is a project by the [@Large Research Group](http://atlarge-research.com). ## Architecture -OpenDC consists of four components: a Kotlin [simulator](/simulator), a MongoDB database, a Python Flask [web server](/web-server), and a React.js [frontend](/frontend), each in their own subdirectories. +OpenDC consists of four components: a Kotlin [simulator](/simulator), a MongoDB database, a Python Flask [web server](/api), and a React.js [frontend](/frontend), each in their own subdirectories.

OpenDC Component Diagram -- cgit v1.2.3 From 9416edf18b2ae9d737e970ad22a79d86935de1c0 Mon Sep 17 00:00:00 2001 From: Fabian Mastenbroek Date: Fri, 17 Jul 2020 11:26:22 +0200 Subject: Update README for renamed API subproject --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 66ffd22d..9ba77427 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ OpenDC is a project by the [@Large Research Group](http://atlarge-research.com). ## Architecture -OpenDC consists of four components: a Kotlin [simulator](/simulator), a MongoDB database, a Python Flask [web server](/api), and a React.js [frontend](/frontend), each in their own subdirectories. +OpenDC consists of four components: a Kotlin [simulator](/simulator), a MongoDB database, a Python Flask [API](/api), and a React.js [frontend](/frontend), each in their own subdirectories.

OpenDC Component Diagram -- cgit v1.2.3 From b27510cbe9de29edb0d1d8be58a49383b836ded5 Mon Sep 17 00:00:00 2001 From: Fabian Mastenbroek Date: Mon, 20 Jul 2020 11:55:31 +0200 Subject: Add deployment information regarding traces --- README.md | 3 +++ 1 file changed, 3 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 9ba77427..0ca14867 100644 --- a/README.md +++ b/README.md @@ -84,6 +84,9 @@ OPENDC_ROOT_DIR=/your/path/to/opendc OPENDC_SERVER_BASE_URL=http://localhost:8081 ``` +Afterwards, you should also create a `traces/` directory in which you place the VM and workflow traces you want to +experiment with. + If you plan to publicly deploy, please also tweak the other settings. In that case, also check the `docker-compose.yml` for further instructions. Now, start the server: -- cgit v1.2.3