redash/README.md

54 lines
3.2 KiB
Markdown
Raw Normal View History

2014-09-17 13:04:30 +00:00
<p align="center">
<img title="re:dash" src='https://raw.githubusercontent.com/EverythingMe/redash/screenshots/redash_logo.png' />
</p>
<p align="center">
2014-09-17 13:06:15 +00:00
<img title="Build Status" src='https://circleci.com/gh/EverythingMe/redash.png?circle-token=8a695aa5ec2cbfa89b48c275aea298318016f040'/>
2014-09-17 13:04:30 +00:00
</p>
2013-10-27 09:24:02 +00:00
2013-10-28 13:18:13 +00:00
**_re:dash_** is our take on freeing the data within our company in a way that will better fit our culture and usage patterns.
2014-09-17 13:04:30 +00:00
Prior to **_re:dash_**, we tried to use traditional BI suites and discovered a set of bloated, technically challenged and slow tools/flows. What we were looking for was a more hacker'ish way to look at data, so we built one.
2013-10-28 13:18:13 +00:00
**_re:dash_** was built to allow fast and easy access to billions of records, that we process and collect using Amazon Redshift ("petabyte scale data warehouse" that "speaks" PostgreSQL).
2014-09-17 13:04:30 +00:00
Today **_re:dash_** has support for querying multiple databases, including: Redshift, Google BigQuery, PostgreSQL, MySQL, Graphite and custom scripts.
2013-10-27 09:24:02 +00:00
2013-10-28 08:33:12 +00:00
**_re:dash_** consists of two parts:
2013-10-27 09:24:02 +00:00
2014-09-17 13:04:30 +00:00
1. **Query Editor**: think of [JS Fiddle](http://jsfiddle.net) for SQL queries. It's your way to share data in the organization in an open way, by sharing both the dataset and the query that generated it. This way everyone can peer review not only the resulting dataset but also the process that generated it. Also it's possible to fork it and generate new datasets and reach new insights.
2. **Dashboards/Visualizations**: once you have a dataset, you can create different visualizations out of it, and then combine several visualizations into a single dashboard. Currently it supports charts, pivot table and cohorts.
2013-10-27 09:24:02 +00:00
2014-09-17 13:04:30 +00:00
**_re:dash_** is a work in progress and has its rough edges and way to go to fulfill its full potential. The Query Editor part is quite solid, but the visualizations need more work to enrich them and to make them more user friendly.
2013-10-27 09:24:02 +00:00
2013-10-30 10:23:16 +00:00
## Demo
2013-10-30 10:37:33 +00:00
![Screenshots](https://raw.github.com/EverythingMe/redash/screenshots/screenshots.gif)
2013-10-30 10:23:16 +00:00
You can try out the demo instance: http://rd-demo.herokuapp.com/ (login with any Google account).
2013-10-30 10:23:49 +00:00
2013-10-30 10:23:16 +00:00
Due to Heroku dev plan limits, it has a small database of flights (see schema [here](http://rd-demo.herokuapp.com/dashboard/schema)). Also due to another Heroku limitation, it is running with the regular user, hence you can DELETE or INSERT data/tables. Please be nice and don't do this.
2013-10-30 11:10:16 +00:00
## Getting Started
2014-09-17 13:04:30 +00:00
* [Setting re:dash on your own server (Ubuntu)](https://github.com/EverythingMe/redash/wiki/Setting-re:dash-on-your-own-server-(for-version-0.4))
2013-10-27 09:24:02 +00:00
2013-10-28 14:51:49 +00:00
2014-09-17 13:04:30 +00:00
## Getting help
2013-10-28 14:51:49 +00:00
2014-09-17 13:04:30 +00:00
* [Google Group (mailing list)](https://groups.google.com/forum/#!forum/redash-users): the best place to get updates about new releases or ask general questions.
* Find us [on gitter](https://gitter.im/EverythingMe/redash#) (chat).
* Contact Arik, the maintainer directly: arik@everything.me.
2013-10-28 14:51:49 +00:00
2014-09-17 13:04:30 +00:00
## Roadmap
2013-10-28 14:51:49 +00:00
2014-09-17 13:04:30 +00:00
TBD.
2013-10-27 09:24:02 +00:00
## Reporting Bugs and Contributing Code
2013-10-28 13:23:10 +00:00
* Want to report a bug or request a feature? Please open [an issue](https://github.com/everythingme/redash/issues/new).
2013-10-28 08:33:12 +00:00
* Want to help us build **_re:dash_**? Fork the project and make a pull request. We need all the help we can get!
2013-10-27 09:24:02 +00:00
## License
2013-10-28 13:21:03 +00:00
See [LICENSE](https://github.com/EverythingMe/redash/blob/master/LICENSE) file.