{"id":15391161,"url":"https://github.com/quramy/ionic-apollo-simple-app","last_synced_at":"2025-04-15T22:40:37.359Z","repository":{"id":66207978,"uuid":"99212694","full_name":"Quramy/ionic-apollo-simple-app","owner":"Quramy","description":"Explains how to develop Ionic application with Apollo GraphQL client","archived":false,"fork":false,"pushed_at":"2018-11-25T07:24:54.000Z","size":2273,"stargazers_count":18,"open_issues_count":1,"forks_count":9,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-23T01:36:24.253Z","etag":null,"topics":["apollo","graphql","ionic3","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Quramy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-08-03T09:00:41.000Z","updated_at":"2025-01-04T21:49:51.000Z","dependencies_parsed_at":"2023-05-29T22:00:23.766Z","dependency_job_id":null,"html_url":"https://github.com/Quramy/ionic-apollo-simple-app","commit_stats":{"total_commits":11,"total_committers":2,"mean_commits":5.5,"dds":"0.36363636363636365","last_synced_commit":"7a5558cccdaed2f096a6df8e38f55936779311aa"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Quramy%2Fionic-apollo-simple-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Quramy%2Fionic-apollo-simple-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Quramy%2Fionic-apollo-simple-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Quramy%2Fionic-apollo-simple-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Quramy","download_url":"https://codeload.github.com/Quramy/ionic-apollo-simple-app/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249167412,"owners_count":21223503,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apollo","graphql","ionic3","typescript"],"created_at":"2024-10-01T15:10:12.861Z","updated_at":"2025-04-15T22:40:37.340Z","avatar_url":"https://github.com/Quramy.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ionic Apollo Simple App\nExplains how to develop Ionic app with Apollo.\n\n## Run app at your local machine\n\nClone this repository and exec :\n\n```sh\ncd ionic-apollo-simple-app\nnpm -g install ionic@latest\nnpm install // # or yarn\nionic serve\n```\n\n## Development Guide\nFrom this point I explain how to integrate GraphQL into Ionic project step by step.\n\n### Scaffold Ionic App\nYou can create the new Ionic app project via\n\n```sh\nnpm install -g ionic@latest\nionic start\n```\n\n### GraphQL Server Side\n[GraphQL](http://graphql.org/) is a query language for API developed by Facebook.\n\nThis app uses [graph.qool](https://console.graph.cool) as GraphQL server.\n\nThis server defines one simple model `User`, which is extended a graph.cool's built-in model. For example, the following GraphQL query:\n\n```graphql\n{\n  allUsers(last: 100) {\n    id, name\n  }\n}\n```\n\nreturns data such as:\n\n```json\n{\n  \"data\": {\n    \"allUsers\": [\n      {\n        \"id\": \"cipgms0x44a2k01p1nlnrfr8z\",\n        \"name\": \"Quramy\"\n      }\n    ]\n  }\n}\n```\n\n*Try query explorer [here](https://api.graph.cool/simple/v1/cipglmpu146dt01mzwqctkbwd?query=%7B%0A%20%20allUsers(last%3A%20100)%20%7B%0A%20%20%20%20id%2C%20name%2C%20email%0A%20%20%7D%0A%7D).*\n\n\n### GraphQL Client Dev tools\nBefore development your app, I introduce two utility libraries for GraphQL client-side development.\n\n- [ts-graphql-plugin](https://github.com/Quramy/ts-graphql-plugin) displays auto completion and syntax \u0026 semantics errors for GraphQL query in your .ts source codes.  \n![complete](capt_complete.gif)\n- [apollo-codegen](https://github.com/apollographql/apollo-codegen) generates TypeScript type annotations from GraphQL query in your source codes.\n\nTo install them via exec:\n\n```sh\nnpm install -S graphql-tag\nnpm install -D apollo-codegen ts-graphql-plugin\n```\n\nAnd edit `tsconfig.json` and `package.json`.\n\n```js\n/* tsconfig.json */\n\n \"compilerOptions\": {\n    // ...\n    \"plugins\": [\n      {\n        \"name\": \"ts-graphql-plugin\",\n        \"schema\": \"schema.json\",\n        \"tag\": \"gql\"\n      }\n    ]\n```\n\n```js\n/* tsconfig.json */\n\n  \"scripts\": {\n    // ...\n    \"gen\": \"apollo-codegen generate --target ts --output src/__generated__.ts \\\"src/**/*.ts\\\"\"\n  },\n```\n\nFinally, download GraphQL Schema JSON file from [graph.cool prayground](https://api.graph.cool/simple/v1/cipglmpu146dt01mzwqctkbwd?query=%7B%0A%20%20allUsers(last%3A%20100)%20%7B%0A%20%20%20%20id%2C%20name%2C%20email%0A%20%20%7D%0A%7D) and save it as `schema.json` under the project.\n![playground_dl](capt_playground_dl.png);\n\nOk, it's ready to go! Open `src/pages/home/home.ts` in your editor or IDE.\n\n```ts\nimport { Component } from '@angular/core';\nimport { NavController } from 'ionic-angular';\n\n// Append the following\nimport gql from 'graphql-tag';\n\nconst query = gql`\n  fragment UserSummary on User {\n    id, name\n  }\n\n  query Users {\n    allUsers(last: 100) {\n      ...UserSummary,\n    }\n  }\n`;\n\n@Component({\n// ...\n```\n\nAnd save `hoge.ts` then, exec `npm run gen` script. After successfully running open `src/__generated__.ts`, you can get the following generated type annotation:\n\n```ts\nexport type UsersQuery = {\n  allUsers:  Array\u003c {\n    id: string,\n    name: string | null,\n  } \u003e,\n};\n\nexport type UserSummaryFragment = {\n  id: string,\n  name: string | null,\n};\n```\n\nThe above types allow us to treat GraphQL queries strictly typed.\n\n### GarphQL Client Side\n\nYou should add a GraphQL client library into your project. This app uses [http://dev.apollodata.com/angular2/] as a GraphQL client.\n\n```sh\nnpm install -S apollo-client apollo-angular\n```\n\n#### Network Interface\n\nFirst, set up GraphQL api connection into this app.\n\nOpen `src/app.module.ts` and append the following snippet.\n\n```ts\n/* app.module.ts */\nimport { ApolloClient, createNetworkInterface } from 'apollo-client';\nimport { ApolloModule } from 'apollo-angular';\n\nexport const client = new ApolloClient({\n  // networkInterface: createNetworkInterface('https://api.graph.cool/simple/v1/cipglmpu146dt01mzwqctkbwd'),\n  networkInterface: createNetworkInterface('https://your-graph.cool-endpoint'),\n});\n\nexport function provideClient(): ApolloClient {\n  return client;\n}\n```\n\nThe `provideClient` function is called Angular DI as provider of `ApolloClient`. `ApolloModule.forRoot()` creates a new Angular module and bind `ApolloClient` provider.\n\n```ts\n@NgModule({\n  // ...\n  imports: [\n    BrowserModule,\n    IonicModule.forRoot(MyApp),\n    ApolloModule.forRoot(provideClient), // \u003c- Append this line\n  ],\n  // ...\n})\n```\n\n#### Execute Query\nWe're ready to execute GraphQL query using ApolloClient provided by Angular DI. Open `src/pages/home/home.ts` and add a dependent service as an argument of constructor.\n\n```ts\nimport gql from 'graphql-tag';\nimport { Apollo } from 'apollo-angular';  // Apollo client service\nimport { UsersQuery, UserSummaryFragment } from '../../__generated__'; // \u003c- Import generated types by `npm run gen`\nimport { Observable } from 'rxjs/Observable';\n\nconst query = gql`\n# ...\n`;\n\nexport class HomePage {\n  constructor(\n    public navCtrl: NavController,\n    private apollo: Apollo, // \u003c- Add apollo client as an Angular service\n  ) { }\n}\n```\n\nA private member field `apollo` is used as a GraphQL API client. Use this service like the following:\n\n```ts\nconst query = gql`\n  fragment UserSummary on User {\n    id, name\n  }\n\n  query Users {\n    allUsers(last: 100) {\n      ...UserSummary,\n    }\n  }\n`;\n\nexport class HomePage {\n  users$: Observable\u003cUserSummaryFragment[]\u003e;\n\n  constructor(\n    public navCtrl: NavController,\n    private apollo: Apollo,\n  ) {\n    this.users$ = this.apollo.query\u003cUsersQuery\u003e({ query })\n      .map(({ data }) =\u003e data.allUsers);\n  }\n}\n```\n\nThe `Users` GraphQL query is executed by `this.apollo.query\u003cUsersQuery\u003e({ query })`. As described above, this query results a JSON data such as:\n\n```json\n{\n  \"data\": {\n    \"allUsers\": [\n      { \"id\": \"u001\", \"name\": \"Alice\" },\n      { \"id\": \"u002\", \"name\": \"Bob\" }\n    ]\n  }\n}\n```\n\nAnd apollo-codegen tells us that the type of the result of this query is `UsersQuery`. `Apollo` service returns result  as a RxJS `Observable` object. So using rxjs operators (e.g. `map` or `pluck` or etc...), we can convert the apollo result to `Observable\u003cUserSummrayFragment[]\u003e`.\n\n#### Display Query Result\nUsing `async` pipe in your template, Anguar automatically subscribe(and also unsubscribe) the apollo stream.\n\n```html\n\u003cion-header\u003e\n  \u003cion-navbar\u003e\n    \u003cion-title\u003eHome\u003c/ion-title\u003e\n  \u003c/ion-navbar\u003e\n\u003c/ion-header\u003e\n\u003cion-content\u003e\n  \u003cion-list\u003e\n    \u003cbutton ion-item *ngFor=\"let user of users$ | async\"\u003e\n      {{user.name}}\n    \u003c/button\u003e\n  \u003c/ion-list\u003e\n\u003c/ion-content\u003e\n```\n\n### Run your app\nThat's all, start app via `ionic serve`!\n\n![home](capt_home.png)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquramy%2Fionic-apollo-simple-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquramy%2Fionic-apollo-simple-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquramy%2Fionic-apollo-simple-app/lists"}