[GitHub] [zeppelin] hsuanxyz commented on a change in pull request #3490: [ZEPPELIN-4321] Rework Zeppelin with Latest Angular

[GitBox <gi...@apache.org>]

hsuanxyz commented on a change in pull request #3490: [ZEPPELIN-4321] Rework Zeppelin with Latest Angular
URL: https://github.com/apache/zeppelin/pull/3490#discussion_r338858441
 
 

 ##########
 File path: zeppelin-frontend/README.md
 ##########
 @@ -0,0 +1,276 @@
+<!--
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~     http://www.apache.org/licenses/LICENSE-2.0
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  -->
+  
+# Zeppelin Front-end
+
+Zeppelin notebooks front-end built with Angular.
+
+- Jira issue [ZEPPELIN-4321](https://issues.apache.org/jira/browse/ZEPPELIN-4321)
+- Design Document: [Zeppelin Notebook Rework Proposal](https://docs.google.com/document/d/1z_VscS81Xwx_3QaexKB2s0uEMEuWKsPXh9mWFRq0-hY)
+
+![screenshot](/screenshot.png?raw=true "Screenshot")
+
+## Setup
+
+### Prerequisites
+
+- [Node.js](https://nodejs.org) version 10.9.0 or later or use [creationix/nvm](https://github.com/creationix/nvm).
+- NPM package manager (which is installed with Node.js by default).
+- [Angular CLI](https://angular.io/cli) version 8.3.0 or later.
+
+### Install
+
+Run the `npm install` command to install dependencies in the project directory.
+
+### Start Zeppelin server
+
+[Run Zeppelin server](https://zeppelin.apache.org/contribution/contributions.html#run-zeppelin-server-in-development-mode) on `http://localhost:8080`.
+
+If you are using a custom port instead of the default(http://localhost:8080) or other network address, you can create `.env` file in the project directory and set `SERVER_PROXY`.
+
+*.env*
+
+```
+SERVER_PROXY=http://localhost:8080
+```
+
+### Development server
+
+Run `npm start` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
+
+### Build
+
+Run `npm build` to build the project. The build artifacts will be stored in the `dist/` directory.
+
+### Running unit tests
+
+Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
+
+## Implementation Progress
+
+### Pages
+
+| Name | Route | Module     | UI |
+| ---  | ----- | ---------- | -- |
+| Home | `/`   | HomeModule |  Y |
+| Login | `/login`       | LoginModule |  Y |
+| Job Manager  | `/jobmanager`  | JobManagerModule |  Y |
+| Interpreter Setting   | `/interpreter` | InterpreterModule |  Y |
+| Notebook | `/notebook/{id}` | NotebookModule |  Y |
+| Notebook Repos | `/notebookRepos` |  |   |
+| Credential     | `/credential` |  |   |
+| Helium | `/helium` |  |  WIP  |
+| Configuration | `/configuration` |  |   |
+
+### Notebook Features
+
+| Feature | Note | Status |
+| ------  | ---- | ---- |
+| Files System  | Create/ Rename/ Import etc.  | Y |
+| Toolbar Actions  | The top toolbar actions   | Y |
+
+### Paragraph Features
+
+| Feature | Note | Status |
+| ------  | ---- | ---- |
+| Grid layout and resizable | | Y |
+| Code Editor | | Y |
+| Actions  | The Corresponding actions of the drop-down menu in the setting button | Y |
+| Actions(hot-keys)  | Support hot-keys for the actions  | WIP |
+| Publishable  | [publish paragraphs](http://zeppelin.apache.org/docs/0.8.0/usage/other_features/publishing_paragraphs.html)  |  |
+| Stream  |  |  |
+
+### Result Display
+
+| Type | Status |
+| ------  | ---- |
+| Dynamic Form  | Y |
+| Text  | Y |
+| Html  |  Y |
+| Table  |  Y |
+| Network  |  |
+
+### Table Visualization
+
+| Type | State |
+| ------ | ---- |
+| Line Chart  | Y |
+| Bard Chart  |  Y |
+| Pie Chart  |  Y |
+| Area Chart  |  Y |
+| Scatter Chart  | Y |
+
+### Helium Visualization
+
+| Type | Note | Status |
+| ------  | ---- | ---- |
+| Prototype | To verify the implementable prototype | Y |
+| Publish Dependencies | Just like [zeppelin-vis](https://github.com/apache/zeppelin/tree/master/zeppelin-web/src/app/visualization)  | WIP |
+| Example Projects |   | Y |
+| Development Documents |   | WIP |
+
+## Contributing
+
+### Dev Mode
+
+Follow the [Setup](#Setup) steps to starting the frontend service. The app will automatically reload if you change any of the source files.
+
+### Technologies
+
+Zeppelin-Frontend-Next is using Angular as the main Framework, before developing we hope highly recommended to have a good knowledge of [Angular](https://angular.io/) and [RxJs](https://github.com/ReactiveX/rxjs).
+
+In addition:
+
+- We use [G2](https://github.com/antvis/g2) visualization
+- We use [Lodash](https://lodash.com/) to process complex data
+- We use [Monaco Editor](https://github.com/microsoft/monaco-editor) to make code editor
 
 Review comment:
   Done

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services