Elgato_dark/zeppelin
1
0
Fork 0
mirror of https://github.com/apache/zeppelin synced 2026-05-24 09:38:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Update Zeppelin-web README.md

Browse source 
Change the wording, delete the contributing part (will be added in another file)
This commit is contained in:
CORNEAU Damien 2015-05-06 14:21:29 +09:00 committed by Damien Corneau
parent 48eed51c04
commit d3c22cf0c6
1 changed files with 26 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

57
zeppelin-web/README.md
View file

@ -1,12 +1,34 @@
# Zeppelin Web Application
This is a Zeppelin web frontend project.
This is Zeppelin's frontend project.
## Compile Zeppelin web
If you want to compile the WebApplication, you will have to simply run `mvn package`.
### New environment
If you want to compile the WebApplication only, you will have to simply run `mvn package` in this folder.
This will Download all the dependencies including node js and npm (you will find the binaries in the folder `zeppelin-web/node`).
We also provide some **helper script** for bower and grunt (you dont need to install them).
We also provide some **helper script** for __bower__ and __grunt__, but they are currently outdated, so you might want to install them on your machine.
### Configured environment
Here are the basic commands to compile the WebApplication with a configured environment (Installed grunt, bower, npm, node js)
**Build the application**
`./grunt build`
**Run the application in dev mode**
``./grunt serve``
This will launch a Zeppelin WebApplication on port **9000** and update on code changes.
(You will need Zeppelin running on the side)
#### Troubleshooting
In case of the error `ECMDERR Failed to execute "git ls-remote --tags --heads git://xxxxx", exit code of #128`
@ -24,31 +46,4 @@ Try to add to the `.bowerrc` file the following content:
and retry to build again.
## Contribute on Zeppelin Web
If you wish to help us to contribute on Zeppelin Web, you will need to install some deps.
Here this is a good start to understand how zeppelin web is architectured.
http://www.sitepoint.com/kickstart-your-angularjs-development-with-yeoman-grunt-and-bower/
### Run the application in dev mode
``./grunt serve``
### Build the application
`./grunt build`
### Add composents to Zeppelin Webapp
* New controller : `yo angular:controller <controlerName>`
* New directive : `yo angular:directive <directiveName>`
* New service : `yo angular:service <serviceName>`
### Add plugin
`./bower install <plugin> -save`
update the file index.html with the new bower_components
ex: `./bower install angular-nvd3`
```
<script src="bower_components/angular-nvd3/dist/angular-nvd3.js"></script>
````
If you wish to help us and contribute to Zeppelin WebApplication, please look at [Zeppelin WebApplication's contribution guideline](contributing.md).