| //// |
| ******************************************************************************* |
| * Copyright (c) 2018 Contributors to the Eclipse Foundation |
| * |
| * See the NOTICE file(s) distributed with this work for additional |
| * information regarding copyright ownership. |
| * |
| * This program and the accompanying materials are made available under the |
| * terms of the Eclipse Public License v. 2.0 which is available at |
| * http://www.eclipse.org/legal/epl-2.0. |
| * |
| * SPDX-License-Identifier: EPL-2.0 |
| ******************************************************************************* |
| //// |
| = openKonsequenz - How to build the module "plannedGridMeasures@openK" |
| :Date: 2017-11-17 |
| :Revision: 1 |
| :icons: |
| :source-highlighter: highlightjs |
| :highlightjs-theme: solarized_dark |
| |
| <<< |
| |
| IMPORTANT: Please be sure that you have first *Portal (Auth n Auth)* installed and configured! |
| |
| == Requirements |
| * Node.js 6.10.3 |
| * Angular-CLI |
| * Graphviz |
| |
| == How to build the Backend |
| To build the backend you need to have installed Apache Maven and Java (look at `/deploy/`*get_started.txt*). |
| |
| === Install Graphviz |
| Graphviz is open source graph visualization software. You need this software because of auto-generated graphics in the documentations. |
| |
| * Download and install Graphviz from https://graphviz.gitlab.io/_pages/Download/Download_windows.html |
| * If not, set the PATH variable |
| |
| Name of variable: GRAPHVIZ_DOT |
| Value of variable: <GRAPHVIZ_DIR>\bin\dot.exe |
| |
| |
| == How to build the Frontend |
| |
| === Install Node.js |
| |
| Node.js is an open-source, cross-platform JavaScript run-time environment for executing JavaScript (also Typescript which is a strongly typed form of JavaScript) code server-side. |
| |
| * Download Node.js 6.10.3 from https://nodejs.org/download/release/v6.10.3/ by clicking on a xxx.msi image for windows. |
| * Run the downloaded Node.js .msi Installer - including accepting the license, selecting the destination, and authenticating for the install. |
| This requires Administrator privileges, and you may need to authenticate |
| * To ensure Node.js has been installed, run the following in your terminal which should show you the installed version. (For example: v6.10.0) |
| |
| [source,command] |
| ---- |
| $ node -v |
| ---- |
| {blank} |
| |
| === Update the npm Angular-CLI client |
| This package manager comes bundled with Node.js and it is good to have the latest version. |
| |
| * Open a command line and navigate to the root folder of the frontend project |
| * Run the following commands (the version is defined in the package.json file): |
| |
| [source,command] |
| ---- |
| $ npm install --save-dev @angular/cli |
| ---- |
| {blank} |
| |
| [source,command] |
| ---- |
| $ npm install |
| ---- |
| {blank} |
| |
| TIP: Next Step -> Read the *howtoRun* file! |
| |
| |
| |
