vedartm / rick-and-morty-info Goto Github PK

Made with Clean architecture + TDD + GraphQL + flutter_bloc + CodeCov + GitHooks + GitHub Actions (CI/CD) and finally with 💙

License: MIT License

Java 0.32% Objective-C 1.59% Dart 93.40% Ruby 2.77% Shell 1.92%

graphql flutter flutter-examples clean-architecture tdd bloc github-actions codecov dart

rick-and-morty-info's Introduction

Rick and Morty Info

A simple app to demonstrate Clean Architecture with GraphQL and flutter_bloc

Motivation

In Martin Fowler's words,

“Any fool can write code that a computer can understand. Good programmers write code that humans can understand.” (Refactoring: Improving the Design of Existing Code, 1999, p. 22)

With this idea in mind, I wanted to demonstrate how we can make a simple app in production grade (and I hope I made my case).

"Production level" implementations

CI/CD with GitHub Actions
Githooks to ensure clean commit and push
- Pre commit formats with flutter format
- Pre push checks the code with flutter analyze and flutter test
Linting style with Effective Dart
Test coverage with Codecov
Dependency Injection with injectable and get_it
Testing with mockito and bloc_test

Screenshots

Installation

Check if you are in the beta channel of flutter SDK and the version v2.0.1 or higher. Instruction to change flutter channel.

Clone the repo

git clone https://github.com/excogitatr/rick-and-morty-info.git

And then we can use the normal build and run procedure
```
flutter pub get
flutter run
```
Some files like *.freezed.dart, *.g.dart, *.iconfig.dart are auto generated. If there is any issue from these files just run this command to regenerate them.
```
flutter pub run build_runner watch --delete-conflicting-outputs
```

Thanks to

unclebob (For the infamous Clean Architecture)
resocoder (Followed his style in Clean architecture)
felangel (For his amazing state management solution)
Axel Fuhrmann (For the Rick and Morty GraphQL API)
Authors of all the packages I have used, who made our lives easier.

Getting Started

For help getting started with Flutter, view the online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

rick-and-morty-info's People

Contributors

Stargazers

Watchers

Forkers

msreekm gidgol ayingzkie trucnguyenlam harshurp20 francovp ravishankarsingh1996 sivatheja10 ameenbadri7 jerazo7 manumura madd86 blizzy312 cchongxd itmentes valksandro baitcenter limcheekin lhdi diabolus sabufung rkzofficial rcdelacruz fanzheyuan praisegeek nikolasmelui definev 0xapurv agent515 swaran18999 raultoto ydhnwb josephdgb1996 irlydontknow yahi99 faisalmushtaq007 jonathanjude abhijithgo mobidian viveky259259 iamisathya marciovalim imanmesgaran cankarabag sstonn mopi1402 aumb davidmic 00xkhaled s-you giosh04 ducquynhnguyeninfo pankokmu1 funncy aiserrock elias8 feihu618 phamthangnd azharmarmu amrahmed242 djihanegh thumv997 clover-leaf kuba-asanov pablogalve devshally patgraczyk juribadev tuanduongdn1504 mrspark2591 hungtrn75 imsamgarg arputharajraja lambiengcode nguyen703 stovietnam rakhimjon twocone adrif31 sayanzz0 scr1ptechnick duong-nk salayna ravivr-dev ogoorchick erlangparasu kumark71 sanjaytechnomers

rick-and-morty-info's Issues

Refactor NetworkInfo

Remove the interface INetworkInfo and refactor the feature and tests accordingly

Question about the entity model

In the api documentation, the character schema has a list of the episode schema.

If I want to make a query like this:

query($page: Int!) {
  characters(page: $page) {
    results {
      id,
      name,
      status,
      species,
      image,
      type,
      episode {
        name,
        air_date,
        episode
        
      }
    }
  }
}

Can I insert the List field in the character entity, for example?

project build/run instructions

hi, thanks for this great example/template project. unf. ive had no luck in being able to get it to build/run. would you be able to add instructions for this ?

How to use this GraphQL implementation for Authenticated link. when auth token is generated in real time.

I was trying your graphql implementation on an app which has authentication (login/signup) now after the login we get the token, how to update the graphql link with the new auth link.

What about example with mutations?

Is your feature request related to a problem? Please describe.
A read-only example is just a tiny tip of the iceberg. When we start to modify data there are a lot of new problems appear.

Complete testing

Adding all test cases

Refactor _getPageFromOffset method

In the file home_bloc.dart
Refactor the function _getPageFromOffset(int offset) by adding +1 inside the function

unable to run example with latest version of graphql-flutter

I tried to run the app with the new version 1.5 of Flutter and also the latest version of
graphql-flutter: ^1.0.0+4

and ran into issues.

The main issue is the fact the Client is not used in the new graphql-flutter version. and refactor to

static final HttpLink httpLink = HttpLink(
    uri: 'https://rickandmortyapi.com/graphql',
  );

is not working.

Are you able to update the example with Flutter 1.5

BTW: using the graphql-flutter version 0.9.5 in combination with Flutter 1.5 gives all kind of errors in the console

thx, and already thx for the great example.