Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

reason-urql

2.1.0 • Public • Published

reason-urql

npm All Contributors Build Status Maintenance Status Spectrum

Reason bindings for Formidable's Universal React Query Library, urql.

✨Features

  • ⚛️ A fully featured GraphQL client for ReasonReact.
  • ✅ Compile time type and schema validation.
  • ⚙️ Customizable behavior via exchanges.
  • 🎣 Support for useQuery, useMutation, useDynamicMutation, useSubscription, and useClient hooks!
  • ⚡ Support for server-side rendering with Next.js.

reason-urql is a GraphQL client for ReasonReact, allowing you to hook up your ReasonReact components to queries, mutations, and subscriptions. It provides bindings to urql that allow you to use the API in Reason, with the benefits of a sound type system, blazing fast compilation, and opportunities for guided customization.

📋 Documentation

💾 Installation

1. Install reason-urql.

yarn add reason-urql

2. Add graphql_ppx_re.

To get the most out of compile time type checks for your GraphQL queries, mutations, and subscriptions, we recommend using graphql_ppx_re. useDynamicMutation in particular takes advantage of some of its internals for an excellent experience writing type safe code to access your GraphQL responses.

yarn add @baransu/graphql_ppx_re --dev

3. Update bsconfig.json.

Add reason-urql to your bs-dependencies and graphql_ppx_re to your ppx_flags in bsconfig.json.

{
  "bs-dependencies": ["reason-urql"],
  "ppx-flags": ["@baransu/graphql_ppx_re/ppx"]
}

4. Send an introspection query to your API.

Finally, you'll need to send an introspection query to your GraphQl API, using a tool like graphql-cli. You should generate a file called graphql_schema.json at the root of your project that graphql_ppx_re can use to type check your queries. You should check this file into version control and keep it updated as your API changes.

For additional instructions, head here.

npx get-graphql-schema ENDPOINT_URL -j > graphql_schema.json

Simply re-run this script at anytime to regenerate the graphql_schema.json file according to your latest backend schema.

💻 Example Projects

reason-urql has a nice set of examples showing how to use the hooks and client APIs to get the most out of GraphQL and Reason in your app – check them out in the /examples folder. To run any of the examples, follow these steps.

# 1. Navigate into the example of choice. 
cd examples/1-execute-query-mutation
 
# 2. Install dependencies. 
yarn
 
# 3. In one terminal, compile the source in watch mode. 
yarn start
 
# 4. In another terminal, start the demo app server. 
yarn start:demo

The example will start up at http://localhost:3000. Edit the example freely to watch changes take effect.

Editing reason-urql source files

If developing on the main reason-urql source files (i.e. anything in /src/) and you want to test the changes in one of the examples, you'll need to do the following:

# Save your changes to source, then take the following steps. 
 
# 1. Clean any artifacts from previous builds. 
yarn clean
 
# 2. Rebuild the source. 
yarn build
 
# 3. Clean example build and reinstall dependencies. 
cd examples/2-query
yarn clean
yarn

Since we are linking the examples' dependency on reason-urql to the src directory, it's important to clean builds between changes to prevent any stale or erroneous artifacts.

Getting Involved

Please help out by opening an issue or filing a PR.

Contributors

This project follows the all contributors spec. Thanks to these wonderful folks for contributing (Emoji Key):


Parker Ziegler

💻 📖 👀 🤔

Khoa Nguyen

💻 📖

Phil Plückthun

🤔

Kara Stubbs

💻 ⚠️ 💡

Marcos Felipe Pimenta Rodrigues

📖

Gustavo Aguiar

💻 💡

Avery Morin

🤔 💻 💡 📖

Alain Armand

💻 💡

Robin Weser

📖

Cem Turan

📖

Huy Nguyen

📖

Sean Grove

💻 💡 🤔 📖

Tomasz Cichocinski

💻 🐛

Jovi De Croock

💻

Corentin Leruth

📖 💻

Joel Jeddeloh

💻

hui.liu

📖

Kévin Combriat

💻 🐛 🤔

Maintenance Status

Experimental: This project is quite new. We're not sure what our ongoing maintenance plan for this project will be. Bug reports, feature requests and pull requests are welcome. If you like this project, let us know!

Install

npm i reason-urql

DownloadsWeekly Downloads

418

Version

2.1.0

License

MIT

Unpacked Size

157 kB

Total Files

71

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar