Files
weave-scope/client/README.md
David Kaltschmidt 8c5638edb2 Asset fingerprinting
* adds `?hash` to JS and CSS bundle URLs against caching in production
* uses `html-webpack-plugin` to generate html dynamically
* html based on template in `app/html/index.html`
* per-app html files no longer needed
* `build/` dir is now completely deleteable, and fully gitignored
* top-level `make` now requires `client/app` to pick up on html and
  style changes
* cleaned up `server.js` code for production bundle testing
* added readme entry about testing production bundles
2016-04-20 12:33:22 +02:00

42 lines
1.3 KiB
Markdown

# Scope UI
## Getting Started (using local node)
- You need nodejs 4.2.2 and a running `weavescope` container
- Setup: `npm install`
- Develop: `BACKEND_HOST=<dockerhost-ip> 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.
## Test Production Bundles Locally
- Build: `npm run build`, output will be in `build/`
- Serve files from `build/`: `BACKEND_HOST=<dockerhost-ip> npm run start-production` and then open `http://localhost:4042/`
## Coding
This directory has a `.eslintrc`, make sure your editor supports linter hints.
To run a linter, you also run `npm run lint`.
## Logging
To enable logging in the console, activate it via `localStorage` in the dev tools console:
```
localStorage["debug"] = "scope:*"
```
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');
```