Skip to content

Commit

Permalink
updated CONTRIBUTING.md to talk about avn and use the new --dev flag …
Browse files Browse the repository at this point in the history
…for bin/kibana
  • Loading branch information
spalger committed Jul 28, 2015
1 parent f9897a3 commit 95eb992
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,17 @@ Please make sure you have signed the [Contributor License Agreement](http://www.

### Development Environment Setup

- Install node.js (we recommend using [nvm](https://github.com/creationix/nvm))
- Clone the kibana repo and move into it

```sh
## follow directions at https://github.com/creationix/nvm, then
nvm install 0.10
git clone https://github.com/elastic/kibana.git kibana
cd kibana
```

- Clone the kibana repo and move into it
- Install the version of node.js listed in the `.node-version` file (this is made easy with tools like [nvm](https://github.com/creationix/nvm) and [avn](https://github.com/wbyoung/avn))

```sh
git clone https://github.com/elastic/kibana.git kibana
cd kibana
nvm install "$(cat .node-version)"
```

- Install dependencies
Expand All @@ -30,10 +29,16 @@ Please make sure you have signed the [Contributor License Agreement](http://www.
npm install
```

- Start elasticsearch, you can use [esvm](https://github.com/simianhacker/esvm) to make that easier.

```sh
grunt esvm:dev:keepalive
```

- Start the development server.

```sh
./node_modules/.bin/grunt dev # use the "--with-es" flag to install & start elasticsearch too
./bin/kibana --dev
```

#### Linting
Expand Down

0 comments on commit 95eb992

Please sign in to comment.