blob: 688050c013e47a4139ef73888dc259f8b5d89be5 [file] [log] [blame]
= openKonsequenz - How to build the module "grid-failure-information@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)* and *ContactBaseData* installed and configured!
== Requirements
* Node.js 12.14.0
* Angular-CLI
== How to build the Backend
To build the backend you need to have installed Apache Maven and Java (look at `/deploy/`*get_started.txt*).
== 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 12.14.0 from https://nodejs.org/download/release/v12.14.0/ 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 - you should get something like 12.14.0
[source,command]
----
$ node -v
----
{blank}
=== Update the npm Angular-CLI client
This package manager comes bundled with Node.js and its 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 *grid-failure-information_howtoRun* file!