ubirch user interface to manage and monitor IOT devices

0. start ubirch-avatar-service at localhost:8080 (default)
1. npm install
2. bower install
3. `grunt serve
4. Open http://localhost:9000

The documentation of the underlying API can be found here

We expect the following tools been installed on the machine:

• Node.js - Install node.js for npm and
• npm, package manager for JavaScript (used for nodejs components)

npm is bundled with node

Download and install Node.js from the following download page:

https://nodejs.org/en/download/

For Unix you can all

    curl -L https://www.npmjs.com/install.sh | sh

• bower, package manager (used for angular components)

    npm install -g bower
  

• grunt, the build tool

    npm install -g grunt-cli
  

If you want to run the latest code from git, here's how to get started:

0. checkout and follow the instructions of the ubirch-avatar-service

    git clone https://github.com/ubirch/ubirch-avatar-service
   

1. Clone the code:

   (deposit your PubKey at gitHub)

    git clone [email protected]:ubirch/ubirch-admin-ui.git
    cd ubirch-admin-ui
   

2. Install the project dependencies

    npm install
   

3. Install the used angular modules

    bower install
   

4. Start backend

See instructions in BE components

5. Build and run the code on localhost:9000

    grunt serve
   

6. Open in Browser:

    http://localhost:9000
   

If you want to deploy the latest version on a server, follow these instructions:

1. Clone the code:

    git clone https://github.com/ubirch/ubirch-admin-ui
    cd ubirch-admin-ui
   

2. Server settings

change the settings, especially in one of the following files:

• settings/settings_local.js
• settings/settings_docker.js
• settings/settings_demo.js
• settings/settings_dev.js

especially change

• the url of the backend api server in UBIRCH_API_HOST
• the url of the ubirch auth service in UBIRCH_AUTH_SERVICE_API_HOST
• specify DEFAULT_DEVICE_TYPE_KEY if it doesn't equal to 'unknownDeviceTypeKey'

3. Run deployment script

For prod (currently demo) deployment execute

    ./deployWeb.sh

For dev deployment execute

    ./deployWeb.sh dev

4. optional: define special settings

• create a file settings/settings_xy.js

• specify all settings properties you find in settings_dev.js

• call

  ./deployWeb.sh xy
  

5. run on localhost

Start the following services on localhost:

• avatar service
• auth service (containing user service endpoints)

Then you can start the admin ui with

    ./testWebLocalhost.sh

When you want to use the services on dev you can start the admin ui with

    ./testWebLocalhostWithDevServices.sh

./goBuild.sh docker

creates a dist version in ./dist/

All files under ./dist/ have to be put into a webserver root folder.

These placeholder:

• ${UBIRCH_API_HOST}
  • e.g. https://api.dev.ubirch.com
• ${UBIRCH_AUTH_SERVICE_API_HOST}
  • e.g. https://auth.dev.ubirch.com

have to be replaced in ./dist/scripts/scripts.*.js

In each dist version all js files have a random number as a part of the filename to avoid caching problems.

This project is a creation of the ubirch GmbH.

If you find bugs or have improvements feel free to contact us:

• send E-Mail

If not otherwise noted in the individual files, the code in this repository is

Copyright © 2016 ubirch GmbH, Author: Beate Fiß

the Apache License Version 2.0, January 2004

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

• This project is generated with yo angular generator - version 0.12.1