1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/web/ synced 2025-03-09 00:00:01 +01:00
No description
Find a file
2020-06-19 15:13:33 +02:00
doc Started revision of VILLASweb documentation 2020-06-04 14:25:53 +02:00
public Use new libcimsvg interface for diagram rendering 2019-03-20 11:21:11 +01:00
src fixes for color control, selected color is now checked 2020-06-19 15:13:33 +02:00
.dockerignore build node application with Docker 2017-07-22 04:03:10 +02:00
.editorconfig added editorconfig 2017-09-20 13:58:07 +02:00
.gitignore Add reverse channel for simulation data 2018-02-06 00:38:32 +01:00
.gitlab-ci.yml CI: add tag to docker image 2020-03-19 12:33:46 +01:00
CONTRIBUTING.md Add contributing.md 2017-08-11 14:09:07 +02:00
COPYING.md Add GPLv3 License 2017-04-27 14:41:44 +02:00
Dockerfile fix license statement in all source files (closes #140) 2020-03-25 13:25:07 +01:00
package-lock.json update dependencies to latest package versions 2020-05-13 15:33:07 +02:00
package.json update dependencies to latest package versions 2020-05-13 15:33:07 +02:00
REACT.md Add README.md, move old README.md to REACT.md 2017-03-16 22:04:30 +01:00
README Add README.md, move old README.md to REACT.md 2017-03-16 22:04:30 +01:00
README.md Add info on test mode of backend including test users. 2020-04-01 09:16:00 +02:00

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-go and VILLASnode.

VILLASnode provides actual simulation data via websockets. VILLASweb-backend-go provides any other data like user accounts, infrastructure components and configurations, dashboards 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.

Data model

Datamodel

Quick start

We recommend Docker to get started quickly:

$ git clone --recursive git@git.rwth-aachen.de:VILLASframework/VILLASweb.git
$ cd VILLASweb
$ npm install
$ npm start

We recommend to start the VILLASweb-backend-go before the frontend. If you want to use test data (including some test users), you can start the backend with the parameter -mode=test. Please check the repository of the VILLASweb-backend-go to find information on the test user login names and passwords. The testing mode is NOT intended for production deployments.

2020, Institute for Automation of Complex Power Systems, EONERC

License

This project is released under the terms of the GPL version 3.

We kindly ask all academic publications employing components of VILLASframework to cite one of the following papers:

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

For other licensing options please consult Prof. Antonello Monti.

Contact

EONERC ACS Logo

Institute for Automation of Complex Power Systems (ACS)
EON Energy Research Center (EONERC)
RWTH University Aachen, Germany