Flutter Interview Project

This is a small project for a Flutter interview.

Goal

Create an mobile application that can retrieve and display random users and specific user repositories from Github.

UX/UI

Up to you but we suggest the following:

Main page: Shows a random list of users (use getRandomUsers on github_api.dart) that can be tapped to navigate to User page and also has a input box on the topbar for entering your own user id to retrieve data (use getUserInformation on github_api.dart) - that input box is display only if a search icon on the top bar is tapped.
User page: Show user information retrieved (Personal Profile Info including image). Has a link to navigate to user repositories page (use getUserRepositories on github_api.dart).
Repositories page: List of repositories of the user with basic information displayed (the more graphical the better)

Contacts comparison feature

We would like to flag random users retrieved from Github that may be in your mobile contact list. So we would like to retrieve the list of contacts in the device and use the names to compare with the list of random retrieve users - if they are similar then we will flag it in the users page on the user entry. A very simple string comparison is fine - if the contact name contains the user Github "login" string then it seems to be a match.

Requirements

Use latest stable flutter version (at this time v3)
Have sound null safety enabled
Use standard flutter navigation for screens (See bonus below for using a routing library)

Retrieving data

To make things easier we have commited a github_api.dart file with the REST APIs needed to retrieve the information.

Submitting the solution

Copy this repository to a repository on your name and add the solution there. It should be clear how to build and run the project locally. Please don't FORK this repo

Bonus (don't need to be in the below specific order)

A nice splash screen
On using sound null safety properly: support null only when it really can be null
Adding a spinner when information is loading
Deal with errors coming from the backend (because eventually it will happen!)
Make sure components/page boundaries are clear
Create model objects for the API data retrieved to avoid working with dynamic (serialisation/deserialisation?). Try to use a library to generate the code for the endpoints (OpenApi? Freezed? Retrofit?)
Some sort of Unit Test
Some sort of Integration Test
Use a routing library available at pub.dev (auto_route? beamer?)
Add localisation
Add some sort of state management to show how that is done (InheritedWidget, Provider, GetIt, Mobx, RiverPod and so on) - We prefer using Mobx if you have experience
Follow Dart style conventions
Create a stream that refreshes the random displayed user list every 15 seconds
Show common tools used for you daily development environment (linters, code formatter, git workflow and so on)
Make sure the app works for the web as well

alanrubin / flutter-interview-project Goto Github PK