Skip to content

remove references to old Heroku app from readme #157

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.

Sign up for GitHub

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

Open
noisyscanner wants to merge 1 commit into
base: main
Choose a base branch
from
Open

remove references to old Heroku app from readme #157

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 2 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,13 +102,7 @@ spago install graphql-client

### Schema

In order to use this library you will need a Purescript representation of your GraphQL schema.

To get started you can convert your grapqhl schema into a purescript schema, using the codegen tool at https://gql-query-to-purs.herokuapp.com . If you are just testing this library out you can paste your graphql schema on the left, copy the purescript schema from the right and add it to your codebase.

If you are looking for a production solution to schema codegen read the rest of this section. If you are just trying the library out, you can skip to the next section.

It is possible to write the schema yourself but it is easier and safer to use the library's codegen tools.
In order to use this library you will need a Purescript representation of your GraphQL schema - this library provides codegen tools to achieve this.

There is an npm library that is a thin wrapper around this library's schema codegen. First, install this package:

Expand Down Expand Up @@ -263,9 +257,6 @@ API documentation can be found at https://pursuit.purescript.org/packages/puresc

Once you are set up and have generated your purescript schema. You can write your queries.

The easiest way to do this is to go to https://gql-query-to-purs.herokuapp.com/query and paste your
graphql query on the left. I usually copy the GraphQL query directly from GraphiQL (GraphQL IDE).

You have to the option to make the queries with either `unit`s to mark scalar values (leaf nodes) or symbol record puns. The symbol record puns are slightly less verbose and closer to GraphQL syntax but require you import the generated Symbols module.

### Decoding and Encoding JSON
Expand All @@ -291,7 +282,7 @@ result <- queryWithDecoder decodeHasura client "query_to_hasura_service"

### Arguments

Arguments can be added using the `Args` constructor or the `=>>` operator. I recommend using the [query codegen tool](https://gql-query-to-purs.herokuapp.com/query) to test this out and see how it works.
Arguments can be added using the `Args` constructor or the `=>>` operator.

As GraphQL arguments may have mixed types, the library provides tools to help handle this.

Expand Down
Loading