|
9 | 9 |
|
10 | 10 | ## Features
|
11 | 11 | ### **Core Features**
|
12 |
| - 1. Starts your GraphQL server (if it is not already running). NOTE: GraphQuill is now compatible with servers running in docker containers. It will check the specified port to see if it is already running. |
| 12 | + 1. Starts your GraphQL server (if it is not already running). |
| 13 | + |
| 14 | + NOTE: GraphQuill is compatible with local and dockerized servers and will check if the specified port has a running server on it. |
| 15 | + GraphQuill is also compatible with **external** API's (accessed via a url in the config file). |
13 | 16 | 2. Parses GraphQL queries/mutations that are typed into the current open document in VS Code.
|
14 |
| - 3. Sends the queries/mutations to your GraphQL API. |
| 17 | + 3. Sends the queries/mutations to the GraphQL API. |
15 | 18 | 4. Renders the responses to the GraphQuill output channel on VS Code.
|
16 | 19 |
|
17 | 20 | <img width="800px" src="./DOCUMENTATION/gifs/basicDemo.gif" alt="demo gif" />
|
|
30 | 33 | GraphQuill can be installed from the VS Code Extensions marketplace [here](https://marketplace.visualstudio.com/items?itemName=sproutdeveloping.graphquill).
|
31 | 34 |
|
32 | 35 | ### **Setting up the config file**
|
33 |
| -Open the command palette in VS Code (Cmd/Ctrl + Shift + P) and select `"GraphQuill: Create GraphQuill Config File"`. A default config file will be generated. If you're using a locally-hosted server, update the entry point with your server's file path and add a port number. If you're using an external server, set the entrypoint to its URL. For more details, refer to the [documentation](./DOCUMENTATION/docs/documentation.md). |
| 36 | +Open the command palette in VS Code (Cmd/Ctrl + Shift + P) and select `"GraphQuill: Create GraphQuill Config File"`. A default config file will be generated. If you're using a **locally-hosted server**, update the entry point with your server's file path and add a port number. If you're using an **external server**, set the entrypoint to its URL. For more details, refer to the [documentation](./DOCUMENTATION/docs/documentation.md). |
34 | 37 |
|
35 | 38 | ### GraphQuill's Mock GraphQL API
|
36 | 39 | A GraphQL API that was used during GraphQuill's development has been open sourced in two repositories on Github to allow users to give GraphQuill a test drive. Below are two repositories, one that has been dockerized, and one that uses locally hosted PostgreSQL and MongoDB databases.
|
@@ -64,4 +67,4 @@ We are always looking to improve. If there are any contributions, feature reques
|
64 | 67 | ## Release Notes
|
65 | 68 | Created by: Alex Chao, Austin Ruby and Edward Greenberg
|
66 | 69 |
|
67 |
| -0.15.0 | Initial release of GraphQuill, More to come! |
| 70 | +0.16.0 | Initial release of GraphQuill, More to come! |
0 commit comments