zeppelin-web/README.md

# Zeppelin Web Application

This is Zeppelin's frontend project.

## Development Guide

### Local Development

It is recommended to install [Node.js](https://nodejs.org) v16 or use [creationix/nvm](https://github.com/creationix/nvm).

All build commands are described in [package.json](./package.json)

```sh
# 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

```sh
# running unit tests
$ npm run karma-test

# running unit tests through Maven (requires node_modules from a prior build)
$ (cd .. && ./mvnw test -pl zeppelin-web -Pweb-classic,web-unit-test)

# running classic UI e2e tests: make sure that a Zeppelin instance started (localhost:8080)
$ cd ../zeppelin-web-angular && npm run e2e:classic
```

- to write unit tests, please refer [Angular Test Patterns](https://github.com/daniellmb/angular-test-patterns)
- to write e2e tests, please refer to the Playwright tests under `zeppelin-web-angular/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:
```xml
<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](https://zeppelin.apache.org/contribution/contributions.html) and the more focused [Zeppelin WebApplication's documentation](https://zeppelin.apache.org/contribution/webapplication.html).