Skip to content

Commit 0458af8

Browse files
jkotovakeydunov
andauthored
fix: readme examples updates (#893)
* fix: readme updates with new examples * fix: readme updates with new examples * fix: readme updates with new examples * fix: readme updates with new examples * fix: readme updates with new examples * fix: readme updates with new examples * fix: readme updates with new examples * fix: readme.md * fix: readme.md * Update README.md Co-authored-by: Artyom Keydunov <artyom.keydunov@gmail.com>
1 parent 0a745d4 commit 0458af8

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Run the following command to get started with Cube.js
6565
$ cubejs create <project name> -d <database type>
6666
```
6767

68-
specifying the project name and your database using `-d` flag. Available options:
68+
specifying the project name and your database using `-d` flag. Available options:
6969

7070
* `postgres`
7171
* `mysql`
@@ -234,14 +234,15 @@ export default () => {
234234

235235
| Demo | Code | Description |
236236
|:------|:----------:|:-------------|
237-
|[Real-Time Dashboard](https://real-time-dashboard-demo.cube.dev/)|[real-time-dashboard](./examples/real-time-dashboard)|Real-Time Dashboard Demo using Web Sockets transport|
238-
|[React Dashboard](https://react-dashboard-demo.cube.dev/)|[react-dashboard](./guides/react-dashboard)|Dynamic dashboard with React, GraphQL, and Cube.js|
239-
|[D3 Dashboard](https://d3-dashboard-demo.cube.dev)|[d3-dashboard](./examples/d3-dashboard)|Dashboard with Cube.js, D3, and Material UI|
240-
|[Stripe Dashboard](http://cubejs-stripe-dashboard-example.s3-website-us-west-2.amazonaws.com/)|[stripe-dashboard](./examples/stripe-dashboard)|Stripe Demo Dashboard built with Cube.js and Recharts|
241-
|[Event Analytics](https://d1ygcqhosay4lt.cloudfront.net/)|[event-analytics](https://github.com/cube-js/cube.js/tree/master/examples/event-analytics)|Mixpanel like Event Analytics App built with Cube.js and Snowplow|
242-
|[Node Express Dashboard](https://express-analytics-dashboard.herokuapp.com)|[node-express-dashboard](https://github.com/cube-js/cube.js/tree/master/examples/express-analytics-dashboard)|Analytics Dashboard with Node, Express, and Cube.js|
237+
|[Real-Time Dashboard](https://real-time-dashboard-demo.cube.dev/)|[real-time-dashboard](./examples/real-time-dashboard)|Real-Time Dashboard Demo using Web Sockets transport [[guide](https://real-time-dashboard.cube.dev)]|
238+
|[React Dashboard](https://react-dashboard-demo.cube.dev/)|[react-dashboard](./guides/react-dashboard)|Dynamic dashboard with React, GraphQL, and Cube.js [[guide](https://react-dashboard.cube.dev)]|
239+
|[D3 Dashboard](https://d3-dashboard-demo.cube.dev)|[d3-dashboard](./examples/d3-dashboard)|Dashboard with Cube.js, D3, and Material UI [[guide](https://d3-dashboard.cube.dev)]|
240+
|[Event Analytics](https://d1ygcqhosay4lt.cloudfront.net/)|[event-analytics](https://github.com/cube-js/cube.js/tree/master/examples/event-analytics)|Mixpanel like Event Analytics App built with Cube.js and Snowplow [[tutorial](https://cube.dev/blog/building-an-open-source-mixpanel-alternative-1/)]|
241+
|[Node Express Dashboard](https://express-analytics-dashboard.herokuapp.com)|[node-express-dashboard](https://github.com/cube-js/cube.js/tree/master/examples/express-analytics-dashboard)|Analytics Dashboard with Node, Express, and Cube.js [[tutorial](https://cube.dev/blog/node-express-analytics-dashboard-with-cubejs/)]|
243242
|[External Rollups](https://cubejs-external-rollups.herokuapp.com/)|[external-rollups](https://github.com/cube-js/cube.js/tree/master/examples/external-rollups)|Compare performance of direct BigQuery querying vs MySQL cached version for the same data|
244-
|[AWS Web Analytics](https://statsbotco.github.io/cubejs-client/aws-web-analytics/)|[aws-web-analytics](./examples/aws-web-analytics)|Web Analytics with AWS Lambda, Athena, Kinesis and Cube.js|
243+
|[AWS Web Analytics](https://statsbotco.github.io/cubejs-client/aws-web-analytics/)|[aws-web-analytics](./examples/aws-web-analytics)|Web Analytics with AWS Lambda, Athena, Kinesis and Cube.js [[tutorial](https://cube.dev/blog/building-open-source-google-analytics-from-scratch/)]|
244+
|[Open Source Web Analytics Platform](https://web-analytics-demo.cubecloudapp.dev/)|[web-analytics](./examples/web-analytics)|Building Google Analytics alternative with Snowplow, AWS Athena, Cube.js and React. It shows the usage of external pre-aggregations to speed-up queries. [[guide](https://web-analytics.cube.dev)]|
245+
|[Drill Down Table API](https://drill-downs.cubecloudapp.dev/)|[drill-downs](./examples/drill-downs)|Quick introduction to the drill downs concept [[tutorial](https://cube.dev/blog/introducing-a-drill-down-table-api-in-cubejs/)] |
245246
|[Examples Gallery](https://statsbotco.github.io/cubejs-client/)|[examples-gallery](./examples/examples-gallery)|Examples Gallery with different visualizations libraries|
246247

247248
## Tutorials
@@ -257,6 +258,7 @@ export default () => {
257258
- [Building an Open Source Mixpanel Alternative. Part 2: Conversion Funnels](https://cube.dev/blog/building-open-source-mixpanel-alternative-2/)
258259
- [Building Open Source Google Analytics from Scratch](https://cube.dev/blog/building-open-source-google-analytics-from-scratch/)
259260
- [React Query Builder with Cube.js](https://cube.dev/blog/react-query-builder-with-cubejs/)
261+
- [Vue Query Builder with Cube.js](https://cube.dev/blog/vue-query-builder-with-cubejs/)
260262
- [External Rollups: Using MySQL as a Cache Layer for BigQuery](https://cube.dev/blog/when-mysql-is-faster-than-bigquery/)
261263

262264

@@ -265,7 +267,7 @@ export default () => {
265267
If you have any questions or need help - [please join our Slack community](https://slack.cube.dev) of amazing developers and contributors.
266268

267269
## Architecture
268-
__Cube.js acts as an analytics backend__, translating business logic (metrics and dimensions) into SQL and handling database connection.
270+
__Cube.js acts as an analytics backend__, translating business logic (metrics and dimensions) into SQL and handling database connection.
269271

270272
The Cube.js javascript Client performs queries, expressed via dimensions, measures, and filters. The Server uses Cube.js Schema to generate a SQL code, which is executed by your database. The Server handles all the database connection, as well as pre-aggregations and caching layers. The result then sent back to the Client. The Client itself is visualization agnostic and works well with any chart library.
271273

@@ -280,7 +282,7 @@ There are many ways you can contribute and help Cube.js. Here a few ones:
280282
* Upvote issues with 👍 reaction so we know what's the demand for particular issue to prioritize it within road map.
281283
* Create issues every time you feel something is missing or goes wrong.
282284
* Ask questions on [Stack Overflow with cube.js tag](https://stackoverflow.com/questions/tagged/cube.js) if others can have these questions as well.
283-
* Provide pull requests for all open issues and especially for those with [help wanted](https://github.com/cube-js/cube.js/issues?q=is%3Aissue+is%3Aopen+label%3A"help+wanted") and [good first issue](https://github.com/cube-js/cube.js/issues?q=is%3Aissue+is%3Aopen+label%3A"good+first+issue") labels.
285+
* Provide pull requests for all open issues and especially for those with [help wanted](https://github.com/cube-js/cube.js/issues?q=is%3Aissue+is%3Aopen+label%3A"help+wanted") and [good first issue](https://github.com/cube-js/cube.js/issues?q=is%3Aissue+is%3Aopen+label%3A"good+first+issue") labels.
284286

285287
All sort of contributions are **welcome and extremely helpful** 🙌 Please refer to [the contribution guide](https://github.com/cube-js/cube.js/blob/master/CONTRIBUTING.md) for more information.
286288

0 commit comments

Comments
 (0)