graphql-ruby readme

README.md

@@ -1,24 +1,139 @@
-# README
+# [💎 How to Graphql with Ruby on Rails](https://www.howtographql.com/graphql-ruby)
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
+## Tutorial contents
 
-Things you may want to cover:
+Each tutorial step is broken down in this repo's [commit history](https://github.com/ztratify/howtographql-rails/commits/main)
 
-* Ruby version
+1. [Getting Started](https://www.howtographql.com/graphql-ruby/1-getting-started/)
+2. Queries
+3. Mutations
+4. Authentication
+5. Connecting Nodes
+6. Error Handling
+7. Filtering
+8. Pagination
+9. Summary
 
-* System dependencies
+## Installation
 
-* Configuration
+Install dependencies:
 
-* Database creation
+```
+bundle install
 
-* Database initialization
+rails db:setup
+```
 
-* How to run the test suite
+Starting the server:
 
-* Services (job queues, cache servers, search engines, etc.)
+```
+rails server
+```
 
-* Deployment instructions
+Opening the application:
 
-* ...
+```
+open http://localhost:3000/
+```
+
+## Interesting Files:
+
+- [GraphqlController](https://github.com/howtographql/graphql-ruby/blob/master/app/controllers/graphql_controller.rb) - GraphQL controller (api entry point)
+- [GraphqlTutorialSchema](https://github.com/howtographql/graphql-ruby/blob/master/app/graphql/graphql_tutorial_schema.rb) - the schema definition
+- [Mutations](https://github.com/howtographql/graphql-ruby/blob/master/app/graphql/types/mutation_type.rb) - root mutations
+- [Queries](https://github.com/howtographql/graphql-ruby/blob/master/app/graphql/types/query_type.rb) - root queries
+- [UserType](https://github.com/howtographql/graphql-ruby/blob/master/app/graphql/types/user_type.rb) - record type
+- [VoteType](https://github.com/howtographql/graphql-ruby/blob/master/app/graphql/types/vote_type.rb) - record type
+- [LinkType](https://github.com/howtographql/graphql-ruby/blob/master/app/graphql/types/link_type.rb) - record type
+- [DateTimeType](https://github.com/howtographql/graphql-ruby/blob/master/app/graphql/types/date_time_type.rb) - scalar type
+- [LinksSearch](https://github.com/howtographql/graphql-ruby/blob/master/app/graphql/resolvers/links_search.rb) - complex search resolver and its [tests](https://github.com/howtographql/graphql-ruby/blob/master/test/graphql/resolvers/links_search_test.rb)
+- [CreateLink](https://github.com/howtographql/graphql-ruby/blob/master/app/graphql/mutations/create_link.rb) - mutation and its [tests](https://github.com/howtographql/graphql-ruby/blob/master/test/graphql/mutations/create_link_test.rb)
+- [CreateUser](https://github.com/howtographql/graphql-ruby/blob/master/app/graphql/mutations/create_user.rb) - mutation and its [tests](https://github.com/howtographql/graphql-ruby/blob/master/test/graphql/mutations/create_user_test.rb)
+- [CreateVote](https://github.com/howtographql/graphql-ruby/blob/master/app/graphql/mutations/create_vote.rb) - mutation and its [tests](https://github.com/howtographql/graphql-ruby/blob/master/test/graphql/mutations/create_vote_test.rb)
+- [SignInUser](https://github.com/howtographql/graphql-ruby/blob/master/app/graphql/mutations/sign_in_user.rb) - mutation and its [tests](https://github.com/howtographql/graphql-ruby/blob/master/test/graphql/mutations/sign_in_user_test.rb)
+
+## Sample GraphQL Queries
+
+List first 10 links, containing "example":
+
+```graphql
+{
+  allLinks(first: 10, filter: {descriptionContains: "example"}) {
+    id
+    url
+    description
+    createdAt
+    postedBy {
+      id
+      name
+    }
+  }
+}
+
+```
+
+Creates new user:
+
+```graphql
+mutation {
+  createUser(
+    name: "Radoslav Stankov",
+    authProvider: {
+      email: { email: "[email protected]", password: "123456" }
+    }
+  ) {
+    id
+    email
+    name
+  }
+}
+```
+
+Creates new user token:
+
+```graphql
+mutation {
+  signinUser(email: {email: "[email protected]", password: "123456"}) {
+    token
+    user {
+      id
+      email
+      name
+    }
+  }
+}
+```
+
+Creates new link:
+
+```graphql
+mutation {
+  createLink(url:"http://example.com", description:"Example") {
+    id
+    url
+    description
+    postedBy {
+      id
+      name
+    }
+  }
+}
+```
+
+Creates new vote:
+
+```graphql
+mutation {
+  createVote(linkId:"TGluay0yMQ==") {
+    user {
+      id
+      name
+    }
+    link {
+      id
+      url
+      description
+    }
+  }
+}
+```