Skip to content

Commit 1927d82

Browse files
committed
v2 / Docs: add info on running tests w/ env vars.
1 parent bdd56d0 commit 1927d82

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ To get set up for development, after cloning this repository:
3636
npm install && npm run clean
3737
```
3838

39-
You'll need a [local installation of Neo4j](http://neo4j.org/download), and it should be running on the default port of 7474.
40-
41-
To run the tests:
39+
To run the tests, you'll need a [local installation of Neo4j](http://neo4j.org/download), running on the default port of 7474, and using the default `neo4j` username and password.
4240

4341
```sh
4442
npm test
4543
```
4644

45+
If your Neo4j installation is running on a different port, or has different credentials, you can specify these things by defining `NEO4J_URL` and/or `NEO4J_AUTH` environment variables. `NEO4J_URL` should be an absolute HTTP URL, and can have auth info embedded (e.g. `http://user:pass@localhost:1234`), while `NEO4J_AUTH` should be just a `username:password` string.
46+
4747
This library is written in [CoffeeScript](http://coffeescript.org/), and we lint the code with [CoffeeLint](http://coffeelint.org/). To lint:
4848

4949
```sh

0 commit comments

Comments
 (0)