docsify init

TuiQiao · Jan 16, 2018 · 752ffe1 · 752ffe1
commit 752ffe1
Show file tree

Hide file tree

Showing 137 changed files with 11,740 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+.idea
diff --git a/.nojekyll b/.nojekyll
diff --git a/README.md b/README.md
@@ -0,0 +1,85 @@
+## Introduction
+An **open** BI Dashboard platform that supports **interactive** multi-dimensional report design and data analysis. Server side framework is Spring+MyBatis and front-end is based on AngularJS1 and Bootstrap. The whole architecture graphic is as below:
+
+<div style="text-align:center">
+  <img class="img-responsive" src="./assets/arch.png"  />
+</div>
+
+
+### Screenshot
+![](/assets/cboard_snapshot.png)
+
+### Near Realtime data refresh
+**Be attention, refresh level is cube level rather than whole dashboard **
+
+![realtime_demo](/assets/realtime_dashboard.gif)
+
+## Features Of CBoard
+
+* Simple and beautiful interface and layout</li>
+* Lightweight architecture and concise source code, the entire project does not rely on any third-party multi-dimensional analysis tools </li>
+  * Front page style and layout of CBoard is based on <a href="http://echarts.baidu.com/">AdminLTE2</a></li>
+  * The chart plugin uses <a href="http://echarts.baidu.com/">ECharts</a> </li>
+  * Javascript uses MVVM AngularJS 1.X framework  </li>
+* Interactive, drag-and-drop **OLAP** classisc report development experience
+* One dataset, multiple report widgets. Maximize reuse query resoult
+* Supports OLAP slice filter operation
+* Supports sort multiple columns/rows at the sametime
+* Global query cache, to avoid repeated query requests for data
+* Support common charts and cross tables</li>
+  * Columnar/Stacked vertical and horizontal bar and line mixed chart with dual axis view
+  * Pie chart
+  * Radar Chart
+  * Sanky Chart
+  * Funnel Chart
+  * KPI Widget
+  * Cross-tabulation (Support Drill Down/Roll Up)
+  * China Map
+  * Bubble Chart
+* Support JDBC data connection
+* Support Native Elasticsearch connection for version 1.x, 2.x, 5.x
+* Support Native Kylin connection for version 1.6
+* Support to connect one of the most popular open source multi-dimensional analysis of products **Saiku2**, and will be able to selectively create data and graphics
+* Cube level data refresh / realtime chart for quick query
+* Easy to implement your own **DataProvider** to connect any data source. Even for expensive commercial BI suite, it's not possible to connect all the NOSQL and NewSQL data source in the era of big data. Due to the schema of NOSQL are various, such as hash tables, arrays, trees, maps, etc., different people using the same NoSQL products designed Schema may vary widely. The user who most familiar with their storage schema are the user themselves. And it's easy to find a Java programmers to code a Class to connect their own data source. So we leave this part of work to the end user with an easy extended data connection framework in CBoard
+
+## Demo
+### Load Data from query or DataSet
+![case 0-switchdataload](/assets/9a874210-cb7d-11e6-9b7e-11721aac322c.gif)
+### Base Operation
+![case 1-](/assets/9c2ead88-cb7d-11e6-9ae4-4c1990f675c2.gif)
+### Switch Chart
+![case2](/assets/9de976b2-cb7d-11e6-8217-4290e5ad039b.gif)
+### Type Calculated Measure
+![case 3-calculatedmeasures 1](/assets/9f3be54a-cb7d-11e6-882b-ef82bbb5100b.gif)
+### Add Dashboard Parameters
+![case4-addboardparam](/assets/74216f2e-cb82-11e6-9612-390a2f93184c.gif)
+### Use Parameters
+![case4-useparam](/assets/73f81fe8-cb82-11e6-95ea-d98b43a4abf2.gif)
+
+
+## Access Control
+**RBAC** (Role Based Access Control), easy admin and view your users' role and roles' access resource list in one page.
+- Grant roles to user by left **Grant** button.
+- Grant access resource to a role by right **Grant** button.
+- Resource can only be granted to role. A user can act as more than one roles.
+
+![image](/assets/UserAdmin_Snap.png)
+
+
+# Road Map
+All tasks are listed in [Issue Page](https://github.com/yzhang921/CBoard/issues) group by milestone.
+Also you can get our development status from [Project Page](https://github.com/yzhang921/CBoard/projects)
+
+
+## Contact us
+You can create any issue or requirements through the Issue system of github.
+If you like CBoard then use it, contribute to CBoard and **don't forget to star it** :star:
+Waiting for your Contribution and pull request!
+
+
+# Let us kown you are using CBoard
+If your company is using CBoard or prepare to use it, please let us known
+
+# Donate (请我们喝咖啡)
+![image](/assets/3eb1f00e-46b4-11e7-900f-77d9b1499f6b.png)
diff --git a/_navbar.md b/_navbar.md
@@ -0,0 +1,21 @@
+- [首页](README.md)
+- [前言](zh-cn/preface.md)
+- 学习
+  - [安装与配置](zh-cn/manual/install.md)
+  - [数据源管理](zh-cn/manual/datasource.md)
+  - [数据集管理](zh-cn/manual/dataset.md)
+  - [图表设计](zh-cn/manual/widget.md)
+  - [看板设计](zh-cn/manual/dashboard.md)
+  - [定时任务](zh-cn/manual/job.md)
+  - [资源分享](zh-cn/manual/shareResource.md)
+  - [用户与权限管理](zh-cn/manual/userAdmin.md)
+- 常见问题
+  - [性能优化]](zh-cn/discuss/optimize.md)
+  - [常见问题](zh-cn/discuss/faq.md)
+- 开发
+  - [开发环境搭建](zh-cn/development/devEnv.md)
+  - [怎么贡献代码](zh-cn/development/howToContribute.md)
+- 其他
+  - [发布日志](zh-cn/extra/releaseNote.md)
+  - [系统升级](zh-cn/extra/updateApp.md)
+  - [谁在使用CBoard](zh-cn/extra/customer.md)
diff --git a/assets/1_OpenProject.png b/assets/1_OpenProject.png
diff --git a/assets/2_show_toolbar.png b/assets/2_show_toolbar.png
diff --git a/assets/2_show_toolbar_2.png b/assets/2_show_toolbar_2.png
diff --git a/assets/3eb1f00e-46b4-11e7-900f-77d9b1499f6b.png b/assets/3eb1f00e-46b4-11e7-900f-77d9b1499f6b.png
diff --git a/assets/4_Facets.png b/assets/4_Facets.png
diff --git a/assets/62f937b6-c2d3-11e6-9d68-71ab6d6c947c.png b/assets/62f937b6-c2d3-11e6-9d68-71ab6d6c947c.png
diff --git a/assets/6_Artifacts.png b/assets/6_Artifacts.png
diff --git a/assets/6d91308c-c2cb-11e6-8366-3422662c0837.png b/assets/6d91308c-c2cb-11e6-8366-3422662c0837.png
diff --git a/assets/73f81fe8-cb82-11e6-95ea-d98b43a4abf2.gif b/assets/73f81fe8-cb82-11e6-95ea-d98b43a4abf2.gif
diff --git a/assets/74216f2e-cb82-11e6-9612-390a2f93184c.gif b/assets/74216f2e-cb82-11e6-9612-390a2f93184c.gif
diff --git a/assets/952a5bfc-c2ce-11e6-89c9-fd15b514c173.png b/assets/952a5bfc-c2ce-11e6-89c9-fd15b514c173.png
diff --git a/assets/9a874210-cb7d-11e6-9b7e-11721aac322c.gif b/assets/9a874210-cb7d-11e6-9b7e-11721aac322c.gif
diff --git a/assets/9c2ead88-cb7d-11e6-9ae4-4c1990f675c2.gif b/assets/9c2ead88-cb7d-11e6-9ae4-4c1990f675c2.gif
diff --git a/assets/9de976b2-cb7d-11e6-8217-4290e5ad039b.gif b/assets/9de976b2-cb7d-11e6-8217-4290e5ad039b.gif
diff --git a/assets/9f3be54a-cb7d-11e6-882b-ef82bbb5100b.gif b/assets/9f3be54a-cb7d-11e6-882b-ef82bbb5100b.gif
diff --git a/assets/AddTomcatRunConf.png b/assets/AddTomcatRunConf.png
diff --git a/assets/Chart_Bubble.png b/assets/Chart_Bubble.png
diff --git a/assets/Chart_Radar.png b/assets/Chart_Radar.png
diff --git a/assets/Deploy1.png b/assets/Deploy1.png
diff --git a/assets/Deploy2.png b/assets/Deploy2.png
diff --git a/assets/ES-CM.png b/assets/ES-CM.png
diff --git a/assets/EditRunConf.png b/assets/EditRunConf.png
diff --git a/assets/KylinDataSet.png b/assets/KylinDataSet.png
diff --git a/assets/RBAC.png b/assets/RBAC.png
diff --git a/assets/Range_Filter.png b/assets/Range_Filter.png
diff --git a/assets/Saiku_Rep.jpg b/assets/Saiku_Rep.jpg
diff --git a/assets/Sanky.png b/assets/Sanky.png
diff --git a/assets/TimeLineBoard.png b/assets/TimeLineBoard.png
diff --git a/assets/UserAdmin_Snap.png b/assets/UserAdmin_Snap.png
diff --git a/assets/add_job.png b/assets/add_job.png
diff --git a/assets/alipay.png b/assets/alipay.png
diff --git a/assets/arch.png b/assets/arch.png
diff --git a/assets/arch2.png b/assets/arch2.png
diff --git a/assets/board_param_template.png b/assets/board_param_template.png
diff --git a/assets/board_snapshot.png b/assets/board_snapshot.png
diff --git a/assets/cboard_snapshot.png b/assets/cboard_snapshot.png
diff --git a/assets/chart_funnel.png b/assets/chart_funnel.png
diff --git a/assets/chart_pie.png b/assets/chart_pie.png
diff --git a/assets/config_param_slider.png b/assets/config_param_slider.png
diff --git a/assets/config_widget.png b/assets/config_widget.png
diff --git a/assets/cross_table.png b/assets/cross_table.png
diff --git a/assets/cross_table_desc.png b/assets/cross_table_desc.png
diff --git a/assets/datasource-presto.png b/assets/datasource-presto.png
diff --git a/assets/datasource-textfile.png b/assets/datasource-textfile.png
diff --git a/assets/demo_datasource.png b/assets/demo_datasource.png
diff --git a/assets/drill_table.gif b/assets/drill_table.gif
diff --git a/assets/ds-test-es.png b/assets/ds-test-es.png
diff --git a/assets/es-cm-completer.png b/assets/es-cm-completer.png
diff --git a/assets/es-datasource.png b/assets/es-datasource.png
diff --git a/assets/es-overide-completer.png b/assets/es-overide-completer.png
diff --git a/assets/es-override.png b/assets/es-override.png
diff --git a/assets/es_dataset.png b/assets/es_dataset.png
diff --git a/assets/filter.png b/assets/filter.png
diff --git a/assets/jdbc-datasource.png b/assets/jdbc-datasource.png
diff --git a/assets/job_email_config.png b/assets/job_email_config.png
diff --git a/assets/kylin-native-datasource.png b/assets/kylin-native-datasource.png
diff --git a/assets/line_bar.png b/assets/line_bar.png
diff --git a/assets/login.jpg b/assets/login.jpg
diff --git a/assets/new_datasource.png b/assets/new_datasource.png
diff --git a/assets/pre-filter.png b/assets/pre-filter.png
diff --git a/assets/push-agg-down.png b/assets/push-agg-down.png
diff --git a/assets/realtime_dashboard.gif b/assets/realtime_dashboard.gif
diff --git a/assets/saiku_crtbl.png b/assets/saiku_crtbl.png
diff --git a/assets/saiku_crtbl_header.png b/assets/saiku_crtbl_header.png
diff --git a/assets/saikuquery.jpg b/assets/saikuquery.jpg
diff --git a/assets/schema.png b/assets/schema.png
diff --git a/assets/select-2.png b/assets/select-2.png
diff --git a/assets/selects_custom_override.png b/assets/selects_custom_override.png
diff --git a/assets/share_resource.png b/assets/share_resource.png
diff --git a/assets/slider_param.png b/assets/slider_param.png
diff --git a/assets/timeline_collapse.png b/assets/timeline_collapse.png
diff --git a/assets/tunning-roadmap.png b/assets/tunning-roadmap.png
diff --git a/assets/use-steps.png b/assets/use-steps.png
diff --git a/assets/widget_desginer.png b/assets/widget_desginer.png
diff --git a/css/font-awesome-4.7.0/HELP-US-OUT.txt b/css/font-awesome-4.7.0/HELP-US-OUT.txt
@@ -0,0 +1,7 @@
+I hope you love Font Awesome. If you've found it useful, please do me a favor and check out my latest project,
+Fort Awesome (https://fortawesome.com). It makes it easy to put the perfect icons on your website. Choose from our awesome,
+comprehensive icon sets or copy and paste your own.
+
+Please. Check it out.
+
+-Dave Gandy