Skip to content

Latest commit

 

History

History
77 lines (47 loc) · 2.62 KB

DEVELOPING.md

File metadata and controls

77 lines (47 loc) · 2.62 KB
Raw

Developing

Prerequisites

Node.js

Node.js version 14.16.0 is required at the time of writing. nvm is recommended for managing your Node.js installation, and we provide a .nvmrc file to aid you in installing and using the correct version of Node.js.

Yarn

Once you have Node.js installed, you should globally install Yarn by running the following:

npm install -g yarn

Cloning the code

If you just want to snoop around, clone our repository using:

https://github.com/neo4j/graphql.git

If you want to make a contribution, fork our repository and perform a clone, preferably over SSH:

[email protected]:USERNAME/graphql.git

You will then need to add our repository as an upstream:

git add remote upstream [email protected]/neo4j/graphql.git

You can then fetch and merge from the upstream to keep in sync.

Getting started

After cloning the repository, simply run the following from the root to get up and running:

yarn install

Code editor

Visual Studio Code comes highly recommended for working in this repository, and we additionally recommend the following extensions:

The Jest extension should automatically detect the tests for this repository and watch them in the Status Bar.

Testing

Tests are run using Jest, which has been configured to allow for execution of test suites at any level in the project. To run all of the tests in the repository, simply run the following command from the root of the project:

NEO_URL=neo4j://localhost:7687 NEO_USER=admin NEO_PASSWORD=password yarn test

In order to run all of the tests, you will need to have a local instance of Neo4j running! We highly recommend Neo4j Desktop to easily get up and running with a local Neo4j instance.

The above command can additionally be run from packages/graphql, packages/ogm, or any directory where there is a jest.config.js file!

Additionally, for projects which have the appropriate Yarn scripts setup, you can run individual test suites. For instance, to run the TCK test suite of @neo4j/graphql, run the following from packages/graphql:

yarn test:tck

Linting/formatting

We use ESLint for linting and Prettier for code formatting. Contributions must adhere to our linting and formatting rules.