Ocelot-Social/web-frontend/installation.md
Robert Schäfer 096f51507c
Typo
@appinteractive if you do documentation I suggest to translate from English to German (or Polish in your case) back and forth. Why? Difficult phrases will not be translated properly and that will make you write very simple English. Second, typos won't be translated and you can spot them easily.
2019-01-02 11:12:08 +01:00

1.8 KiB

Web Installation

{% hint style="warning" %} This documentation should be split into a local and a docker installation variant. Also maybe there should be a main docker installation guide for the whole system at once!? {% endhint %}

Clone Repository

The Frontend Repository can be found on github.
https://github.com/Human-Connection/Nitro-Web

git@github.com:Human-Connection/Nitro-Web.git

Install Dependencies

{% hint style="danger" %} Current you have to use the --ignore-engines parameter on install, as the izitoast wrapper package claims to not work on node >= 9 which is not true. If the Author does not responde we might fork the package or make our own component out of it. So it's a temporary issue. {% endhint %}

{% tabs %} {% tab title="Yarn" %}

cd styleguide && yarn install --ignore-engines && cd ..
yarn install --ignore-engines

{% endtab %}

{% tab title="NPM" %}

cd styleguide && npm install --ignore-engines && cd ..
npm install --ignore-engines

{% endtab %} {% endtabs %}

Development

To start developing you need to start the server with the dev command. This will give you "hot reload" which updates the browser content mostly without reloading the whole page.

{% tabs %} {% tab title="Yarn" %}

yarn dev

{% endtab %}

{% tab title="NPM" %}

npm run dev

{% endtab %} {% endtabs %}

This will start the UI under http://localhost:3000

For development environments, we created three users with different profiles and privileges.

Login to the app with one the following credentials:

password: 1234 (same for all profiles)

You should see this under http://localhost:3000