amwebexpert / guess_the_text Goto Github PK

• configurable timer
• default to 2 minutes
• visual update inside the game
• on timeout the word game ends

• find a way to drive Flutter imports ordering, grouping
• refactor relative project imports the ../../../xyz.dart way?

File:

• app_error.widget.dart

Should:

• display available categories
• handle the user choice on press

Normal behavior is to retrieve BE live categories, but if offline mode is detected or a network error occurs, the in-app storage should be the fallback

Make the screen adapt the presentation depending on portrait / landscape modes

• Add new french categories like:
  • Countries and capitals
  • Languages

• feature to allow user to provide the full response inside a text box

Better responsive support through this popular library:

• https://pub.dev/packages/responsive_framework
• https://resocoder.com/2021/10/03/create-responsive-flutter-apps-with-minimal-effort/

I simplified the version extraction regex for now by quick and dirty fix: removing these lines 🤣 so the first semantic number detected is the one below... this could be improved later because I'm going to create the issue !

Originally posted by @amwebexpert in #67 (comment)

Actual behavior:

• one categories are retrieved from API call, the app default selection to the very first one

Expected behavior:

• each time a user pick a category, we should persist the selected one
• on app startup we should check if we have a persisted category, double check if it (still) exists and select it

There are packages for that purpose.
The goal here is to read, document, analyse and compare, find the best approach and transform existing code manual serializations:

• prepare a 1st ADR
• 1st candidate https://pub.dev/packages/json_serializable
• 2nd candidate https://pub.dev/packages/freezed

• actually the user randomly has to guess the same text over and over because we just don't memoize
• perhaps we should not store at first on local storage (or if we do, we should also provide a mean to reset guessed texts with confirmation 🤔)

• add instructions to create and test the build

Detected an issue with the connectivity_plus api when the platform is the web:

Proposed fix:

• conditional rendering inside parent widget: only render when platform is NOT web

Something like:

   const DataCell(ifNotWebPlatform ? ConnectivityStatusWidget() : '√'),

Record stats regarding:

• number of success
• number of failure
• global category scores

• add instructions to create and test the build

Add the following screen captures to the top of the README.md

• iPhone animated gif
• Android animated gif
• Web app animated gif

Add example of a local files storage service

• .env configurations for local and production
• See also flutter_dotenv

Informations like:

• width and height
• portrait / landscape detected mode
• pixel ratio
• text scaling factor

Description of the issue:

• https://stackoverflow.com/questions/49340116/setstate-called-after-dispose

Add instructions in the README.md about how to produce the coverage report
That would be great for anyone asking what's covered so far 🤔

Detail instructions:

• to generate the stats lcov file
• tooling for converting that to a nice browsable html report

Actually the build number and version default to 1.0.0 and blank strings

• update build-windows.cmd to automate replacement inside Runner.rc
• update attributes ProductVersion and FileVersion to match [pubspec.yaml](https://github.com/amwebexpert/guess_the_text/blob/master/pubspec.yaml)

    BLOCK "StringFileInfo"
    BEGIN
        BLOCK "040904e4"
        BEGIN
            VALUE "CompanyName", "Open Source software (MIT LICENSE)" "\0"
            VALUE "FileDescription", "Open Source Educational game application" "\0"
            VALUE "FileVersion", VERSION_AS_STRING "\0"
            VALUE "InternalName", "GuessTheText" "\0"
            VALUE "LegalCopyright", "Copyright (C) 2022 André Masson. All rights reserved." "\0"
            VALUE "OriginalFilename", "GuessTheText.exe" "\0"
            VALUE "ProductName", "Guest the text" "\0"
            VALUE "ProductVersion", VERSION_AS_STRING "\0"
        END
    END

Once this pull request is merged, enhance the categories screen:

• enhance the TextService by adding a Future<Map<ApiCategory, File>> getCategoryCacheFilesMap() async
  • NOTE: for performance purpose, we could have null as File value, so we know the file does not exists instead of leaving the consumer call file.existsSync on each file later...
  • could also be implemented Future<Map<ApiCategory, CacheModel>> getCategoryCacheFilesMap() async to avoid implementation leak!
  • see Directory('my-dir').listSync to list all files of a directory
• add an File param to the CategoryWidget
• add detail to the CategoryWidget:
  • timestamp of the last cached content (if the file exists)
  • category language label
• bonus: leading icon for the language
• trailing icon to show if any cached content exists

Look for TODOs like

• // TODO translate me i18n
• // TODO Localize me

It's about adding the labels in the lib/i10n/*.arb, regenerating the code through flutter run so the generated class will have the additional attributes, and will therefore be usable instead of the harcoded string

• add instructions to create and test the build

This is an opportunity to implement SQLite on all platforms

• write instructions for starting backend on localhost

Actual DataTable widget does not take full width. Proposed fixes to experiment:

• https://stackoverflow.com/questions/56625052/how-to-make-a-multi-column-flutter-datatable-widget-span-the-full-width/62263430#62263430

• user should be able to share the QR code (as a file? encodedText? picture?)
• recipient should be able to accept chalenge from shared QR code

For some platforms, the QR code reader wont be supported (web platform?)

• read the documentation of the dart library we are using
• detection of unsupported platform
• disable the menu option of accepting challenge

The project is having more than one contributor so improve the about screen accordingly by transforming the single author name and linkedin profile with a list of authors

• create the Contributor model class
• add a public array of hard coded contributors
• modify the app.version.table.widget.dart widget to iterate through the new contributors array and show their info

Once this pull request is merged, enhance the categories screen:

This depends on #79

• add offline mode detection through connectivity_plus
• wait for connectivity status to be retrieved before displaying any content
• disable the ListTile onPress whenever no cached content exists for the specific category

• new feature screen
• navigation to that screen
• form with minimal fields (email, title, comments)
• fields validation with error feedbacks
• form submit by creating a mailto link and opening it

Add code coverage for the about screen

• should display application version
• should display backend api version

Full tutorial and Example code available:

• https://www.youtube.com/watch?v=8j7W91ZJuV0

Should

• display languages section
• display dark/light modes section
• should call the store to persist changes

References:

• https://opensource.guide/starting-a-project/#writing-your-contributing-guidelines
• https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors

Very (too much) complete example we can be inspired by:

• https://github.com/atom/atom/blob/master/CONTRIBUTING.md