diff --git a/README.md b/README.md index c00b42a40..6b152cffd 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,33 @@ -[![MIT License][license-badge]][license-link] -[![Financial Contributors on Open Collective](https://opencollective.com/graphql-flutter/all/badge.svg?label=financial+contributors)](https://opencollective.com/graphql-flutter) [![All Contributors](https://img.shields.io/badge/all_contributors-31-orange.svg?style=flat-square)](#contributors) -[![PRs Welcome][prs-badge]][prs-link] +
+

GraphQL Flutter

-[![Star on GitHub][github-star-badge]][github-star-link] -[![Watch on GitHub][github-watch-badge]][github-watch-link] -[![Discord][discord-badge]][discord-link] +
+ +
-# GraphQL Flutter +

+ A collection of packages to work with graphql server in dart and flutter. +

-### πŸ“Œ   Bulletin -* [Join the discord.][discord-link] +

+ Project Homepage +

-## About this project + + GitHub Workflow Status (branch) + + + + Pub Popularity + + + + Discord + + +
+ +## Introduction GraphQL brings many benefits, both to the client: devices will need fewer requests, and therefore reduce data usage. And to the programmer: requests are arguable, they have the same structure as the request. @@ -21,36 +37,20 @@ The project took inspiration from the [Apollo GraphQL client](https://github.com ## Packages -[![Build Status][build-status-badge]][build-status-link] -[![Coverage][coverage-badge]][coverage-link] - This is a Monorepo which contains the following packages: -| Package | Pub | -| :-------------------------------------------- | :----------------------------------------------- | -| [graphql/client.dart](./packages/graphql) | [![version][version-badge]][package-link-client] | -| [graphql_flutter](./packages/graphql_flutter) | [![version][version-badge]][package-link] | - -## Examples - -Here are some examples you can follow: - -1. [Starwars Example](./examples/starwars) +| Crate | Description | Version | +|:----------|:-----------:|--:| +| [graphql](./packages/graphql) | Client implementation to interact with any graphql server | ![Pub Version (including pre-releases)](https://img.shields.io/pub/v/graphql?include_prereleases&style=flat-square) | +| [graphql_flutter](./packages/graphql_flutter) | Flutter Widgets wrapper around graphql API | ![Pub Version (including pre-releases)](https://img.shields.io/pub/v/graphql_flutter?include_prereleases&style=flat-square) | ## Utils Tools -Around graphql_flutter are builds awesome tools like: +Around `graphql_flutter` are builds awesome tools like: 1. [graphql_flutter_bloc](https://github.com/artflutter/graphql_flutter_bloc) 2. [graphql_codegen](https://github.com/heftapp/graphql_codegen) -## Articles and Videos - -External guides, tutorials, and other resources from the GraphQL Flutter community - -- [Ultimate toolchain to work with GraphQL in Flutter](https://medium.com/@v.ditsyak/ultimate-toolchain-to-work-with-graphql-in-flutter-13aef79c6484): - An intro to using `graphql_flutter` with [`artemis`](https://pub.dev/packages/artemis) for code generation and [`graphql-faker`](https://github.com/APIs-guru/graphql-faker) for API prototyping - ## Features βœ…   Queries, Mutations, and Subscriptions βœ…   [Query polling and rebroadcasting](./packages/graphql/README.md#clientwatchquery-and-observablequery) @@ -63,65 +63,12 @@ External guides, tutorials, and other resources from the GraphQL Flutter communi ## Contributing -To contribute, please see the [CONTRIBUTING.md](CONTRIBUTING.md) file. +Please see our [Hacking guide](./docs/dev/MAINTAINERS.md) ## Contributors This package was originally created and published by the engineers at [Zino App BV](https://zinoapp.com). Since then the community has helped to make it even more useful for even more developers. -Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)): - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Eustatiu Dima
πŸ› πŸ’» πŸ“– πŸ’‘ πŸ€” πŸ‘€
Zino Hofmann
πŸ› πŸ’» πŸ“– πŸ’‘ πŸ€” πŸš‡ πŸ‘€
Harkirat Saluja
πŸ“– πŸ€”
Chris Muthig
πŸ’» πŸ“– πŸ’‘ πŸ€”
Cal Pratt
πŸ› πŸ’» πŸ“– πŸ’‘ πŸ€”
Miroslav Valkovic-Madjer
πŸ’»
Aleksandar Faraj
πŸ›

Arnaud Delcasse
πŸ› πŸ’»
Dustin Graham
πŸ› πŸ’»
FΓ‘bio Carneiro
πŸ›
Gregor
πŸ› πŸ’» πŸ€”
Kolja Esders
πŸ› πŸ’» πŸ€”
Michael Joseph Rosenthal
πŸ› πŸ’» πŸ“– πŸ’‘ πŸ€” ⚠️ πŸ–‹ πŸš‡ 🚧 πŸ“† πŸ’¬ πŸ‘€ βœ…
Igor Borges
πŸ› πŸ’»

Rafael Ring
πŸ› πŸ’»
TruongSinh Tran-Nguyen
πŸ’» πŸ–‹ πŸ“– πŸ’‘ πŸ€” πŸš‡ ⚠️ βœ…
Maina Wycliffe
πŸ’» πŸ“– πŸ’‘
Lucas de Ávila Martins
πŸ’»
szantogab
πŸ’»
dbrb
πŸ’»
Yunyu Lin
πŸ’»

Ammar Atef
πŸ’»
Ariel Carbonaro
πŸ’»
ArneSchulze
πŸ’»
Christian Wesselhoeft
πŸ’»
JarrodCColburn
πŸ’»
M. Walker Wells
πŸ’»
Mateus Gustavo de Freitas e Silva
πŸ’»

pleopardi
πŸ’»
Sat Mandir S. Khalsa
πŸ’»
Nitish Kumar Singh
πŸ’»
- - - - - This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind are welcome! [build-status-badge]: https://img.shields.io/github/workflow/status/zino-hofmann/graphql-flutter/graphql-flutter%20Tests%20case?style=flat-square @@ -142,13 +89,6 @@ This project follows the [all-contributors](https://github.com/kentcdodds/all-co [discord-badge]: https://img.shields.io/discord/559455668810153989.svg?style=flat-square&logo=discord&logoColor=ffffff [discord-link]: https://discord.gg/tXTtBfC -## Contributors - -### Code Contributors - -This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. - - ### Financial Contributors Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/graphql-flutter/contribute)] @@ -171,3 +111,10 @@ Support this project with your organization. Your logo will show up here with a + +## Articles and Videos + +External guides, tutorials, and other resources from the GraphQL Flutter community + +- [Ultimate toolchain to work with GraphQL in Flutter](https://medium.com/@v.ditsyak/ultimate-toolchain-to-work-with-graphql-in-flutter-13aef79c6484): + An intro to using `graphql_flutter` with [`artemis`](https://pub.dev/packages/artemis) for code generation and [`graphql-faker`](https://github.com/APIs-guru/graphql-faker) for API prototyping diff --git a/packages/graphql/README.md b/packages/graphql/README.md index 1d4ac4284..533143387 100644 --- a/packages/graphql/README.md +++ b/packages/graphql/README.md @@ -1,18 +1,35 @@ -[![MIT License][license-badge]][license-link] -[![All Contributors](https://img.shields.io/badge/all_contributors-31-orange.svg?style=flat-square)](#contributors) -[![PRs Welcome][prs-badge]][prs-link] +
+

GraphQL

-[![Star on GitHub][github-star-badge]][github-star-link] -[![Watch on GitHub][github-watch-badge]][github-watch-link] -[![Discord][discord-badge]][discord-link] +
+ +
-[![Build Status][build-status-badge]][build-status-link] -[![Coverage][coverage-badge]][coverage-link] -[![version][version-badge]][package-link] +

+ Client implementation to interact with any graphql server +

-# GraphQL Client +

+ Project Homepage +

-[`graphql/client.dart`](https://pub.dev/packages/graphql) is a GraphQL client for dart modeled on the [apollo client], and is currently the most popular GraphQL client for dart. It is co-developed alongside [`graphql_flutter`](https://pub.dev/packages/graphql_flutter) [on github](https://github.com/zino-app/graphql-flutter), where you can find more in-depth examples. We also have a lively community alongside the rest of the GraphQL Dart community on [discord][discord-link]. + + GitHub Workflow Status (branch) + + + + Pub Popularity + + + + Discord + + +
+ +## Introduction + +[graphql/client.dart](https://pub.dev/packages/graphql) is a GraphQL client for dart modeled on the [apollo client], and is currently the most popular GraphQL client for dart. It is co-developed alongside [`graphql_flutter`](https://pub.dev/packages/graphql_flutter) [on github](https://github.com/zino-app/graphql-flutter), where you can find more in-depth examples. We also have a lively community alongside the rest of the GraphQL Dart community on [discord][discord-link]. As of `v4`, it is built on foundational libraries from the [gql-dart project], including [`gql`], [`gql_link`], and [`normalize`]. We also depend on [hive](https://docs.hivedb.dev/#/) for persistence via `HiveStore`. diff --git a/packages/graphql_flutter/README.md b/packages/graphql_flutter/README.md index 8b1a28959..477306715 100644 --- a/packages/graphql_flutter/README.md +++ b/packages/graphql_flutter/README.md @@ -1,16 +1,33 @@ -[![MIT License][license-badge]][license-link] -[![All Contributors](https://img.shields.io/badge/all_contributors-31-orange.svg?style=flat-square)](#contributors) -[![PRs Welcome][prs-badge]][prs-link] +
+

GraphQL Flutter

-[![Star on GitHub][github-star-badge]][github-star-link] -[![Watch on GitHub][github-watch-badge]][github-watch-link] -[![Discord][discord-badge]][discord-link] +
+ +
-[![Build Status][build-status-badge]][build-status-link] -[![Coverage][coverage-badge]][coverage-link] -[![version][version-badge]][package-link] +

+ Flutter Widgets wrapper around graphql API +

-# GraphQL Flutter +

+ Project Homepage +

+ + + GitHub Workflow Status (branch) + + + + Pub Popularity + + + + Discord + + +
+ +## Introduction `graphql_flutter` provides an idiomatic flutter API and widgets for [`graphql/client.dart`](https://pub.dev/packages/graphql). They are co-developed [on github](https://github.com/zino-app/graphql-flutter), where you can find more in-depth examples. We also have a lively community on [discord][discord-link].