tree: 159978e6a2913d0a773a54fbbfbdb9443ed15ea6 [path history] [tgz]
  1. e2e/
  2. src/
  3. .babelrc
  4. .editorconfig
  5. .eslintrc
  6. Gruntfile.js
  7. karma.conf.js
  8. package-lock.json
  9. package.json
  10. pom.xml
  11. protractor.conf.js
  12. README.md
  13. webpack.config.js
zeppelin-web/README.md

Zeppelin Web Application

This is Zeppelin's frontend project.

Development Guide

Local Development

It is recommended to install Node.js v16 or use creationix/nvm.

All build commands are described in package.json

# install required depepdencies (only once)
$ npm install

# build zeppelin-web for production
$ npm run build:dist

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

Supports the following options with using npm environment variable when running the web development mode.

# if you are using a custom port instead of default(8080),
# you must use the 'SERVER_PORT' variable to run the web application development mode
$ SERVER_PORT=YOUR_ZEPPELIN_PORT npm run dev

# if you want to use a web dev port instead of default(9000),
# you can use the 'WEB_PORT' variable
$ WEB_PORT=YOUR_WEB_DEV_PORT npm run dev

Testing

# running unit tests
$ npm run karma-test

# running e2e tests: make sure that zeppelin instance started (localhost:8080)
$ npm run e2e

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

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 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.