From f7518a4d196ccf9e3ef16829d4129fbb44242726 Mon Sep 17 00:00:00 2001 From: Georgios Andreadis Date: Fri, 31 Mar 2017 15:00:24 +0200 Subject: Add page-overview to README.md --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index ec4f3186..1717fb12 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,14 @@ This document gives a high-level view of the frontend architecture ([jump](#arch ## Architecture -### Interaction Model -[TODO] +### Application Interaction Model +Let's first take a look at how the user interacts with the frontend. + +#### Pages +The user starts at the splashpage (`index.html`) where he/she gets a first impression of OpenDC, including screenshots and features. After signing in with Google Authentication, the user is redirected to the page listing all projects (`projects.html`) shared or owned by that user. Here the user also has the possibility to open a particular project, redirecting to the main application page (`app.html`). + +#### Main Application +The main application allows the user to construct and simulate a datacenter. To understand how the user can do this, have a look at the state diagram below. It visualizes the main interactions a user can make with the application, as well as under which conditions. ![OpenDC Frontend Interaction State Diagram](https://raw.githubusercontent.com/atlarge-research/opendc-frontend/master/images/opendc-frontend-interaction-state-diagram.png) -- cgit v1.2.3