diff options
| author | Georgios Andreadis <g.andreadis@student.tudelft.nl> | 2017-09-22 15:17:42 +0200 |
|---|---|---|
| committer | Georgios Andreadis <g.andreadis@student.tudelft.nl> | 2017-09-23 10:06:16 +0200 |
| commit | 906845d8c379701b948d4f2dcf954cbb01177412 (patch) | |
| tree | 3fd024425e051108122ece6c5a39ca99947ab2d5 | |
| parent | b32c5c06ee844072a760f776e5f37f7c32c97c8f (diff) | |
Add info on pages to README.md
| -rw-r--r-- | README.md | 16 |
1 files changed, 14 insertions, 2 deletions
@@ -7,11 +7,23 @@ The user-facing component of the OpenDC stack, allowing users to build and inter ## 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 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. ### Pages -// +All pages are represented by a component in the `src/pages` directory. There are components for the following pages: + +**Home.js** - Entry page (`/`) + +**Simulations.js** - Overview of simulations the user (`/simulations`) + +**App.js** - Main application, with datacenter construction and simulation UI (`/simulations/:simulationId` and `/simulations/:simulationId/experiments/:experimentId`) + +**Experiments.js** - Overview of experiments of the current simulation (`/simulations/:simulationId/experiments`) + +**Profile.js** - Profile of the current user (`/profile`) + +**NotFound.js** - 404 page to appear when route is invalid (`/*`) ### Components & Containers |