zeppelin/zeppelin-web/README.md
1ambda abe03a866f [ZEPPELIN-1667] Fix maven options while updating node, npm packages
### What is this PR for?

Update maven plugin, node vesion, npm package and fix tests to make #1639 pass CI

### What is the Jira issue?

Sub issue of #1639

### Questions:

Does the licenses files need update? NO
Is there breaking changes for older versions? YES (front-end build tool usage changed)
Does this needs documentation? YES (front-end build tool usage changed)

Author: 1ambda <1amb4a@gmail.com>

Closes #1659 from 1ambda/pr/1639 and squashes the following commits:

e5b414b [1ambda] docs: Add a package installation command
d8c9d36 [1ambda] docs: Update zeppelin-web/README.md
f0fcdff [1ambda] feat: Add start script to package.json
a2aab1f [1ambda] fix: Remove useless script
5cdd813 [1ambda] fix: Print warn, error log only while packing
5e1e746 [1ambda] fix: Caching npm, bower, node directories
ac40b56 [1ambda] test: fix test for jasmine-core 2.x
ded1f2c [1ambda] chore: Update karma, phantom related package version
6bb52cc [1ambda] chore: Add slient option to bower (show error only)
ca2359c [1ambda] fix: Restore bower install option
4c26211 [1ambda] chore: Update node, npm version to avoid proxy error
e085809 [1ambda] chore: Remove bower install root option
488092a [1ambda] chore: fix travis maven option
668a687 [1ambda] chore: Set maven option using mavenrc
f42531a [1ambda] chore: Update assembly plugin version
532f1e6 [1ambda] fix(web): npm tasks in pom.xml
6568960 [1ambda] chore: Add test, build task to npm
314dcd8 [1ambda] chore: Update frontend plugin version
2016-11-23 20:58:08 +09:00

1.9 KiB

Zeppelin Web Application

This is Zeppelin's frontend project.

Development Guide

Packaging

If you want to package the zeppelin-web only, simply run this command in this folder.
This will download all the dependencies including node (the binaries in the folder zeppelin-web/node)

$ mvn package 

Local Development

It is recommended to install node 6.0.0+ since Zeppelin uses 6.9.1+ (see creationix/nvm)

All build commands are described in package.json

# install required depepdencies and bower packages (only once)
$ npm install

# build zeppelin-web for production
$ npm run build

# run frontend application only in dev mode (localhost:9000) 
# you need to run zeppelin backend instance also
$ npm run start 

# execute tests
$ npm run test

Troubleshooting

Git error

In case of the error ECMDERR Failed to execute "git ls-remote --tags --heads git://xxxxx", exit code of #128

change your git config with git config --global url."https://".insteadOf git://

Proxy issues

Try to add to the .bowerrc file the following content:

  "proxy" : "http://<host>:<port>",
  "https-proxy" : "http://<host>:<port>"

also try to add proxy info to npm install command:

<execution>
	<id>npm install</id>
	<goals>
    	<goal>npm</goal>
    </goals>
    <configuration>
    	<arguments>--proxy=http://<host>:<port> --https-proxy=http://<host>:<port></arguments>
    </configuration>
</execution>

and retry to build again.

Contribute on Zeppelin Web

If you wish to help us and contribute to Zeppelin WebApplication, please look at the overall project contribution guidelines and the more focused Zeppelin WebApplication's documentation.