-
-
Notifications
You must be signed in to change notification settings - Fork 514
Add GraphQL guide #630
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Add GraphQL guide #630
Changes from all commits
Commits
Show all changes
25 commits
Select commit
Hold shift + click to select a range
f5b7b41
Including GraphQL API card
davimacedo 58137a8
GraphQL guide boilerplate
davimacedo 81b5e3f
GraphQL theme
davimacedo ba7e008
Introduction
davimacedo 6886e83
Running
davimacedo 0ddac5c
Crafting getting started section
davimacedo 3ea59c6
Adding images to the getting started
davimacedo 51dd50b
Including server customize
davimacedo ed87dc8
Your first query section
davimacedo 4bab895
Remove server customize session
davimacedo 4d8d42d
Adding objects section
davimacedo c7bc315
Object Create Generic Mutation section
davimacedo 3632c3b
Class create mutation section
davimacedo 893230c
Finding objects section
davimacedo d0028f2
Constraints, order and pagination sections
davimacedo 8ba8b6b
Updating objects section
davimacedo 3f6f2fc
Deleting an object section
davimacedo 785e5d9
Users boilerplate
davimacedo 8fb08dc
Signing up section
davimacedo 3901037
Logging out section
davimacedo 9a935f0
Me query example
davimacedo 12d0bd2
Learning more section
davimacedo 38f3a0c
Update _includes/graphql/learning-more.md
davimacedo 464373e
Update _includes/graphql/users.md
davimacedo 39cb770
Update _includes/graphql/users.md
davimacedo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Getting Started | ||
|
||
[GraphQL](https://graphql.org/), developed by Facebook, is an open-source data query and manipulation language for APIs. In addition to the traditional [REST API](/rest/guide/), Parse Server automatically generates a GraphQL API based on your current application schema. | ||
|
||
The easiest way to run the Parse GraphQL Server is using the CLI: | ||
|
||
```bash | ||
$ npm install -g parse-server mongodb-runner | ||
$ mongodb-runner start | ||
$ parse-server --appId APPLICATION_ID --masterKey MASTER_KEY --databaseURI mongodb://localhost/test --mountGraphQL --mountPlayground | ||
``` | ||
|
||
Notes: | ||
* Run `parse-server --help` or refer to [Parse Server Options](https://parseplatform.org/parse-server/api/master/ParseServerOptions.html) for a complete list of Parse Server configuration options. | ||
* ⚠️ Please do not use `--mountPlayground` option in production as anyone could access your API Playground and read or change your application's data. | ||
|
||
After running the CLI command, you should have something like this in your terminal: | ||
|
||
<img alt="Parse GraphQL Server" data-echo="{{ '/assets/images/graphql/parse-graphql-server.png' | prepend: site.baseurl }}"/> | ||
|
||
Since you have already started your Parse GraphQL Server, you can now visit [http://localhost:1337/playground](http://localhost:1337/playground) in your web browser to start playing with your GraphQL API. | ||
|
||
<img alt="GraphQL Playground" data-echo="{{ '/assets/images/graphql/graphql-playground.png' | prepend: site.baseurl }}"/> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Learning More | ||
|
||
If you look at the right side of your GraphQL Playground, you will see the DOCS and SCHEMA menus. They are automatically generated by analyzing your application schema and contain all operations that you can call for your application, including the automatic class queries and mutations. Please refer to them and learn more about everything that you can do with your Parse GraphQL API. | ||
|
||
<img alt="GraphQL Docs" data-echo="{{ '/assets/images/graphql/graphql-docs.png' | prepend: site.baseurl }}"/> | ||
|
||
Additionally, the [GraphQL Learn Section](https://graphql.org/learn/) is a very good source to start learning about the power of the GraphQL language. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't mind if this isn't done in this PR, but do we need to provide different instructions for Windows users?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure. Do you have an Windows machine to test by any chance? :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no. @oallouch I believe you use a Windows machine? - if you get a chance it would be great if you could test this out.