Skip to content

Commit 5b37708

Browse files
Merge pull request #99 from jdorleans/hotfix/installation-doc
#97 - Step-by-step doc installation for this plugin
2 parents 32d6739 + f88a7cc commit 5b37708

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,40 @@ It provides the following features in IntelliJ IDEA, WebStorm, RubyMine, PhpStor
1616

1717
It depends on [js-graphql-language-service](https://github.com/jimkyndemeyer/js-graphql-language-service) that it manages using a Node.js process handler.
1818

19+
## Installation
20+
1. Install Node JS
21+
```
22+
# Ubuntu
23+
sudo apt install nodejs
24+
25+
# Mac OS
26+
brew install node
27+
```
28+
29+
2. Install Node JS and JS GraphQL Plugin in IntelliJ
30+
```
31+
1. File | Settings | Plugins
32+
2. Search for: nodejs and graphql
33+
3. Install both plugins and Restart
34+
```
35+
36+
3. Set Node JS Interpreter in IntelliJ
37+
```
38+
1. File | Settings | Languages & Frameworks | Node.js and NPM Node interpreter
39+
2. Add... (search for nodejs bin path in your system)
40+
41+
# Ubuntu
42+
whereis nodejs
43+
/usr/bin/nodejs
44+
45+
# Mac OS
46+
which node
47+
48+
# Windows
49+
where node
50+
```
51+
At this point JS GraphQL will recognize your `.graphql` files. However, if you wish to customize your schema, follow the FAQ.
52+
1953
## Documentation
2054

2155
The plugin uses a `graphql.config.json` file in the project root to configure the location of your GraphQL schema.

0 commit comments

Comments
 (0)