Files
weave-scope/client/README.md
David Kaltschmidt d9a1aa9807 Fix make client-start
* made webpack host configurable via env
* start via `make WEBPACK_SERVER_HOST=local.docker client-start`
* removed port from BACKEND_HOST env
2016-04-06 14:30:36 +02:00

41 lines
1.2 KiB
Markdown

# Scope UI
## Requirements
## Getting Started (using local node)
- You need nodejs 4.2.2 and a running `weavescope` container
- Setup: `npm install`
- Build: `npm run build`, output will be in `build/`
- Develop: `BACKEND_HOST=<dockerhost-ip>:4040 npm start` and then open `http://localhost:4042/`
This will start a webpack-dev-server that serves the UI and proxies API requests to the container.
## Getting Started (using node in a container)
- You need a running `weavescope` container
- Develop: `make WEBPACK_SERVER_HOST=<dockerhost-ip> client-start` and then open `http://<dockerhost-ip>:4042/`
This will start a webpack-dev-server that serves the UI from the UI build container and proxies API requests to the weavescope container.
## Coding
This directory has a `.eslintrc`, make sure your editor supports linter hints.
To run a linter, you also run `npm run lint`.
## Logging
The Scope UI uses [debug](https://www.npmjs.com/package/debug) for logging, e.g.,:
```
const debug = require('debug')('scope:app-store');
debug('Store log message');
```
To enable logging in the console, activate it via `localStorage` in the dev tools console:
```
localStorage["debug"] = "scope:*"
```