diff --git a/README.md b/README.md index 5de6a7122ab..a61640b096a 100644 --- a/README.md +++ b/README.md @@ -9,65 +9,8 @@ Graphite, Elasticsearch, OpenTSDB, Prometheus and InfluxDB. ![](http://docs.grafana.org/assets/img/features/dashboard_ex1.png) -- [Install instructions](http://docs.grafana.org/installation/) -- [What's New in Grafana 2.0](http://docs.grafana.org/guides/whats-new-in-v2/) -- [What's New in Grafana 2.1](http://docs.grafana.org/guides/whats-new-in-v2-1/) -- [What's New in Grafana 2.5](http://docs.grafana.org/guides/whats-new-in-v2-5/) -- [What's New in Grafana 3.0](http://docs.grafana.org/guides/whats-new-in-v3/) -- [What's New in Grafana 4.0](http://docs.grafana.org/guides/whats-new-in-v4/) -- [What's New in Grafana 4.1](http://docs.grafana.org/guides/whats-new-in-v4-1/) -- [What's New in Grafana 4.2](http://docs.grafana.org/guides/whats-new-in-v4-2/) -- [What's New in Grafana 4.3](http://docs.grafana.org/guides/whats-new-in-v4-3/) -- [What's New in Grafana 4.4](http://docs.grafana.org/guides/whats-new-in-v4-4/) - -## Features - -### Graphing -- Fast rendering, even over large timespans -- Click and drag to zoom -- Multiple Y-axis, logarithmic scales -- Bars, Lines, Points -- Smart Y-axis formatting -- Series toggles & color selector -- Legend values, and formatting options -- Grid thresholds, axis labels -- [Annotations](http://docs.grafana.org/reference/annotations/) -- Any panel can be rendered to PNG (server side using phantomjs) - -### Dashboards -- Create, edit, save & search dashboards -- Change column spans and row heights -- Drag and drop panels to rearrange -- [Templating](http://docs.grafana.org/reference/templating/) -- [Scripted dashboards](http://docs.grafana.org/reference/scripting/) -- [Dashboard playlists](http://docs.grafana.org/reference/playlist/) -- [Time range controls](http://docs.grafana.org/reference/timerange/) -- [Share snapshots publicly](http://docs.grafana.org/v2.0/reference/sharing/) - -### InfluxDB -- Use InfluxDB as a metric data source, annotation source -- Query editor with field and tag typeahead, easy group by and function selection - -### Graphite -- Graphite target expression parser -- Feature rich query composer -- Quickly add and edit functions & parameters -- Templated queries -- [See it in action](http://docs.grafana.org/datasources/graphite/) - -### Elasticsearch, Prometheus & OpenTSDB -- Feature rich query editor UI - -### Alerting -- Define alert rules using graphs & query conditions -- Schedule & evalute alert rules, send notifications to Slack, Hipchat, Email, PagerDuty, etc. - -## Requirements -There are no dependencies except an external time series data store. For dashboards and user accounts Grafana can use an embedded -database (sqlite3) or you can use an external SQL data base like MySQL or Postgres. - ## Installation -Head to [grafana.org](http://docs.grafana.org/installation/) and [download](https://grafana.com/get) +Head to [docs.grafana.org](http://docs.grafana.org/installation/) and [download](https://grafana.com/get) the latest release. If you have any problems please read the [troubleshooting guide](http://docs.grafana.org/installation/troubleshooting/). @@ -84,27 +27,10 @@ the latest master builds [here](https://grafana.com/grafana/download) - Go 1.8.1 - NodeJS LTS -### Get Code - -```bash -go get github.com/grafana/grafana -``` - -Since imports of dependencies use the absolute path `github.com/grafana/grafana` within the `$GOPATH`, -you will need to put your version of the code in `$GOPATH/src/github.com/grafana/grafana` to be able -to develop and build grafana on a cloned repository. To do so, you can clone your forked repository -directly to `$GOPATH/src/github.com/grafana` or you can create a symbolic link from your version -of the code to `$GOPATH/src/github.com/grafana/grafana`. The last options makes it possible to change -easily the grafana repository you want to build. -```bash -go get github.com/*your_account*/grafana -mkdir $GOPATH/src/github.com/grafana -ln -s $GOPATH/src/github.com/*your_account*/grafana $GOPATH/src/github.com/grafana/grafana -``` - ### Building the backend ```bash -cd $GOPATH/src/github.com/grafana/grafana +go get github.com/grafana/grafana +cd ~/go/src/github.com/grafana/grafana go run build.go setup go run build.go build ``` @@ -123,8 +49,7 @@ npm run build To build the frontend assets only on changes: ```bash -sudo npm install -g grunt-cli # to do only once to install grunt command line interface -grunt && grunt watch +npm run dev ``` ### Recompile backend on source change @@ -134,11 +59,6 @@ go get github.com/Unknwon/bra bra run ``` -### Running -```bash -./bin/grafana-server -``` - Open grafana in your browser (default: `http://localhost:3000`) and login with admin user (default: `user/pass = admin/admin`). ### Dev config @@ -149,9 +69,6 @@ You only need to add the options you want to override. Config files are applied 1. grafana.ini 1. custom.ini -## Create a pull request -Before or after you create a pull request, sign the [contributor license agreement](http://docs.grafana.org/project/cla/). - ## Contribute If you have any idea for an improvement or found a bug do not hesitate to open an issue. And if you have time clone this repo and submit a pull request and help me make Grafana diff --git a/package.json b/package.json index 900a5b0acee..5ac5c01d8d9 100644 --- a/package.json +++ b/package.json @@ -59,7 +59,8 @@ }, "scripts": { "build": "./node_modules/grunt-cli/bin/grunt", - "test": "./node_modules/grunt-cli/bin/grunt test" + "test": "./node_modules/grunt-cli/bin/grunt test", + "dev": "./node_modules/grunt-cli/bin/grunt && ./node_modules/grunt-cli/bin/grunt watch" }, "license": "Apache-2.0", "dependencies": {