diff options
| author | Georgios Andreadis <g.andreadis@student.tudelft.nl> | 2017-09-22 17:30:21 +0200 |
|---|---|---|
| committer | Georgios Andreadis <g.andreadis@student.tudelft.nl> | 2017-09-23 10:06:16 +0200 |
| commit | f3bddcbc8273695ab6247b3f0f54f9c930757f2b (patch) | |
| tree | e498b00d3ac2d3b44d724d20f0215448b07a26cb | |
| parent | 906845d8c379701b948d4f2dcf954cbb01177412 (diff) | |
Continue README.md documentation
| -rw-r--r-- | README.md | 10 |
1 files changed, 5 insertions, 5 deletions
@@ -15,7 +15,7 @@ All pages are represented by a component in the `src/pages` directory. There are **Home.js** - Entry page (`/`) -**Simulations.js** - Overview of simulations the user (`/simulations`) +**Simulations.js** - Overview of simulations of the user (`/simulations`) **App.js** - Main application, with datacenter construction and simulation UI (`/simulations/:simulationId` and `/simulations/:simulationId/experiments/:experimentId`) @@ -23,16 +23,16 @@ All pages are represented by a component in the `src/pages` directory. There are **Profile.js** - Profile of the current user (`/profile`) -**NotFound.js** - 404 page to appear when route is invalid (`/*`) +**NotFound.js** - 404 page to appear when the route is invalid (`/*`) ### Components & Containers -// +The building blocks of the UI are divided into so-called *components* and *containers* (as [encouraged](https://medium.com/@dan_abramov/smart-and-dumb-components-7ca2f9a7c7d0) by the author of Redux). *Components* are considered 'pure', rendered as a function of input properties. *Containers*, on the other hand, are wrappers around *components*, injecting state through the properties of the components they wrap. ### State Management -// +Almost all state is kept in a central Redux store. State is kept there in an immutable form, only to be modified through actions being dispatched. These actions are contained in the `src/actions` folder, and the reducers (managing how state is updated according to dispatched actions) are located in `src/reducers`. If you're not familiar with the Redux approach to state management, have a look at [their official documentation](http://redux.js.org/). ### API Interaction -// +The web-app needs to pull data in from the API of a backend running on a server. The functions that call routes are located in `src/api`. The actual logic responsible for calling these functions is contained in `src/sagas`. These API fetch procedures are written with the help of `redux-saga`. Learn more about this way of getting API data in Redux on [their official documentation](https://redux-saga.js.org/). |