public | ||
src | ||
.gitignore | ||
package.json | ||
REACT.md | ||
README | ||
README.md |
VILLASweb
Description
This is VILLASweb, the website displaying and processing simulation data in the web browser. The term frontend refers to this project, the actual website.
The frontend connects to two backends: VILLASweb-backend and VILLASnode.
VILLASnode provides actual simulation data via websockets. VILLASweb-backend provides any other data like user acounts, simulation configuration etc.
For more information on the backends see their repositories.
Frameworks
The frontend is build upon ReactJS and Flux.
React is responsible for rendering the UI and Flux for handling the data and communication with the backends. For more information also have a look at REACT.md
Additional libraries are used, for a complete list see package.json.
Quick start
To start the website locally run npm start
. This will open a local webserver serving the frontend. To make the website work, you still need to start at least the VILLASweb-backend (See repository for information).