Skip to content

Commit

Permalink
docs: Update test section in zeppelin-web/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
1ambda committed Jul 10, 2017
1 parent 15473de commit 76f4f58
Showing 1 changed file with 22 additions and 12 deletions.
34 changes: 22 additions & 12 deletions zeppelin-web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,6 @@ 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](https://github.com/creationix/nvm))
Expand All @@ -30,10 +21,8 @@ $ yarn run build
# run frontend application only in dev mode (localhost:9000)
# you need to run zeppelin backend instance also
$ yarn run dev

# execute tests
$ yarn run test
```

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

```
Expand All @@ -44,7 +33,28 @@ $ SERVER_PORT=YOUR_ZEPPELIN_PORT yarn 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 yarn run dev
```

### Testing

```sh
# running unit tests
$ yarn run test

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

- to write unit tests, please refer [Angular Test Patterns](https://github.com/daniellmb/angular-test-patterns)
- to write e2e tests, please refer [Protractor Tutorial](http://www.protractortest.org/#/tutorial#step-1-interacting-with-elements)

### 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
Expand Down

0 comments on commit 76f4f58

Please sign in to comment.