Some README updates

MaironLucas · Jun 15, 2024 · 9fb7e6b · 9fb7e6b
1 parent 8aef755
commit 9fb7e6b
Show file tree

Hide file tree

Showing 14 changed files with 31 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -9,3 +9,21 @@ To run, put this additional arg to you flutter run:
 ```
  --dart-define-from-file=.env
 ```
+
+## Architecture and used packages
+Lets take a look on how the app is structured and what features/packages are used.
+
+### App Theme
+The app Theme was created using the [Material Design](https://material.io/design) guidelines and the 
+[Material Design Builder](https://material-foundation.github.io/material-theme-builder/) to generate 
+files accordingly to the selected params (colors and fonts). The generated files are located in the 
+'lib/common/theme' folder.
+
+### Routing
+The app uses [go_router](https://pub.dev/packages/go_router) to handle the routing. 
+The routes are defined in the 'lib/common/routing' folder.
+
+## Dependency Injection
+The app uses [get_it](https://pub.dev/packages/get_it) to handle the dependency injection. All the 
+classes registered in the 'lib/common/di' folder are available to be injected in the app. In general, 
+I choose to inject Data Sources, Repositories, Use Cases and some resources like Dio.
diff --git a/lib/common/theme.dart → lib/common/theme/theme.dart b/lib/common/theme.dart → lib/common/theme/theme.dart
@@ -344,7 +344,7 @@ class MaterialTheme {
        bodyColor: colorScheme.onSurface,
        displayColor: colorScheme.onSurface,
      ),
-     scaffoldBackgroundColor: colorScheme.background,
+     scaffoldBackgroundColor: colorScheme.surface,
      canvasColor: colorScheme.surface,
   );
 

diff --git a/lib/common/util.dart → lib/common/theme/util.dart b/lib/common/util.dart → lib/common/theme/util.dart
diff --git a/lib/data/remote/model/arena_rm.dart b/lib/data/remote/model/arena_rm.dart
@@ -2,7 +2,7 @@ import 'package:json_annotation/json_annotation.dart';
 
 part 'arena_rm.g.dart';
 
-@JsonSerializable()
+@JsonSerializable(createToJson: false)
 class ArenaRM {
   ArenaRM(
     this.city,

diff --git a/lib/data/remote/model/date_rm.dart b/lib/data/remote/model/date_rm.dart
@@ -2,7 +2,7 @@ import 'package:json_annotation/json_annotation.dart';
 
 part 'date_rm.g.dart';
 
-@JsonSerializable()
+@JsonSerializable(createToJson: false)
 class DateRM {
   DateRM(
     this.start,

diff --git a/lib/data/remote/model/game_status_rm.dart b/lib/data/remote/model/game_status_rm.dart
@@ -2,7 +2,7 @@ import 'package:json_annotation/json_annotation.dart';
 
 part 'game_status_rm.g.dart';
 
-@JsonSerializable()
+@JsonSerializable(createToJson: false)
 class GameStatusRM {
   GameStatusRM(
     this.clock,

diff --git a/lib/data/remote/model/game_summary_rm.dart b/lib/data/remote/model/game_summary_rm.dart
@@ -8,7 +8,7 @@ import 'package:nbapp/data/remote/model/teams_rm.dart';
 
 part 'game_summary_rm.g.dart';
 
-@JsonSerializable()
+@JsonSerializable(createToJson: false)
 class GameSummaryRM {
   GameSummaryRM(
     this.id,

diff --git a/lib/data/remote/model/periods_rm.dart b/lib/data/remote/model/periods_rm.dart
@@ -2,7 +2,7 @@ import 'package:json_annotation/json_annotation.dart';
 
 part 'periods_rm.g.dart';
 
-@JsonSerializable()
+@JsonSerializable(createToJson: false)
 class PeriodsRM {
   PeriodsRM(
     this.current,

diff --git a/lib/data/remote/model/scores_rm.dart b/lib/data/remote/model/scores_rm.dart
@@ -3,7 +3,7 @@ import 'package:nbapp/data/remote/model/team_score_rm.dart';
 
 part 'scores_rm.g.dart';
 
-@JsonSerializable()
+@JsonSerializable(createToJson: false)
 class ScoresRM {
   ScoresRM(
     this.visitors,

diff --git a/lib/data/remote/model/team_rm.dart b/lib/data/remote/model/team_rm.dart
@@ -2,7 +2,7 @@ import 'package:json_annotation/json_annotation.dart';
 
 part 'team_rm.g.dart';
 
-@JsonSerializable()
+@JsonSerializable(createToJson: false)
 class TeamRM {
   TeamRM(
     this.id,

diff --git a/lib/data/remote/model/team_score_rm.dart b/lib/data/remote/model/team_score_rm.dart
@@ -2,7 +2,7 @@ import 'package:json_annotation/json_annotation.dart';
 
 part 'team_score_rm.g.dart';
 
-@JsonSerializable()
+@JsonSerializable(createToJson: false)
 class TeamScoreRM {
   TeamScoreRM(
     this.win,

diff --git a/lib/data/remote/model/teams_rm.dart b/lib/data/remote/model/teams_rm.dart
@@ -3,7 +3,7 @@ import 'package:nbapp/data/remote/model/team_rm.dart';
 
 part 'teams_rm.g.dart';
 
-@JsonSerializable()
+@JsonSerializable(createToJson: false)
 class TeamsRM {
   TeamsRM(
     this.visitors,

diff --git a/lib/main.dart b/lib/main.dart
@@ -1,13 +1,11 @@
 import 'dart:async';
 
 import 'package:flutter/material.dart';
-import 'package:get_it/get_it.dart';
-import 'package:go_router/go_router.dart';
 import 'package:logger/logger.dart';
 import 'package:nbapp/common/di.dart';
 import 'package:nbapp/common/routing/routing.dart';
-import 'package:nbapp/common/theme.dart';
-import 'package:nbapp/common/util.dart';
+import 'package:nbapp/common/theme/theme.dart';
+import 'package:nbapp/common/theme/util.dart';
 
 class Log {
   Logger logger = Logger(printer: PrettyPrinter());
@@ -39,9 +37,7 @@ void main() async {
 }
 
 class _MyApp extends StatelessWidget {
-  const _MyApp({
-    super.key,
-  });
+  const _MyApp();
 
   @override
   Widget build(BuildContext context) {

diff --git a/test/widget_test.dart b/test/widget_test.dart
@@ -8,7 +8,6 @@
 import 'package:flutter/material.dart';
 import 'package:flutter_test/flutter_test.dart';
 
-import 'package:nbapp/main.dart';
 
 void main() {
   testWidgets('Counter increments smoke test', (WidgetTester tester) async {