Matheus Massula Test

.fvmrc

@@ -0,0 +1,3 @@
+{
+  "flutter": "3.13.9"
+}

.gitignore

@@ -30,6 +30,8 @@
 .pub-cache/
 .pub/
 /build/
+**/build/
+**/*.mocks.dart
 
 # Web related
 lib/generated_plugin_registrant.dart

.vscode/launch.json

@@ -5,9 +5,28 @@
     "version": "0.2.0",
     "configurations": [
         {
-            "name": "app",
+            "name": "app-dev",
             "request": "launch",
-            "type": "dart"
-        }
+            "type": "dart",
+            "program": "${workspaceFolder}\/lib\/main_dev.dart",
+        },
+        {
+            "name": "app-prod",
+            "request": "launch",
+            "type": "dart",
+            "program": "${workspaceFolder}\/lib\/main_prod.dart",
+        },
+        {
+            "name": "app-dev-windows",
+            "request": "launch",
+            "type": "dart",
+            "program": "${workspaceFolder}\\lib\\main_dev.dart",
+        },
+        {
+            "name": "app-prod-windows",
+            "request": "launch",
+            "type": "dart",
+            "program": "${workspaceFolder}\\lib\\main_prod.dart",
+        },
     ]
 }

.vscode/settings.json

@@ -1,9 +1,11 @@
 {
     "dart.flutterSdkPath": ".fvm/flutter_sdk",
-    "search.exclude": {
-        "**/.fvm": true
-    },
-    "files.watcherExclude": {
-        "**/.fvm": true
-    }
+	// Remove .fvm files from search
+	"search.exclude": {
+		"**/.fvm": true
+	},
+	// Remove from file watching
+	"files.watcherExclude": {
+		"**/.fvm": true
+	}
 }

README.md

@@ -181,3 +181,52 @@ Just create a new issue in this repo and we will respond and get back to you qui
 ## Review
 
 The coding challenge is a take-home test upon which we'll be conducting a thorough code review once complete. The review will consist of meeting some more of our mobile engineers and giving a review of the solution you have designed. Please be prepared to share your screen and run/demo the application to the group. During this process, the engineers will be asking questions.
+
+---
+
+## Clear documentation on the structure and architecture of your application.
+
+I based the app structure on a mix of "package by layer" and "package by feature" called as "package by convenience" on [this book](https://www.kodeco.com/14214369-infinite-scrolling-pagination-in-flutter).
+
+Basically follow similar rules:
+### 1 Features get their own package
+
+In this project a feature can be considered as any screen
+
+### 2 Features don't know each other
+
+The navigation responsability is designated to the [AppRouter](lib\app_router.dart)
+
+### 3 Repositories get their own package
+
+In this project, repository was understood as data sources and each one got their own package
+- [YelpRepository](packages\yelp_repository\lib\src\yelp_repository.dart): Responsible to retrieve data from yelp api
+- [LocalStorage](packages\local_storage\lib\src\local_storage.dart): Responsible to store data in the device
+
+### 4 Specialized packages
+
+Code that are meant for one specific purpose, but can be used in more than one place
+- [Component Library](packages\component_library): Widgets that were made by design team and are meant to be used in more than one place
+- [Domain Models](packages\domain_models): Data classes that will be used in the features (screens). Other packages that handle other data type must use the other data type only internally.
+
+## Tests
+
+The tests were made in the following files:
+- [unit test](packages\features\restaurant_detail\test\unit\restaurant_detail_cubit_test.dart)
+- [widget/flow test](test\widget_test.dart)
+
+## Environment setup
+If you are using a mac you can:
+- update the [.env_prod](assets\env\/.env_prod) file with the yelp api key
+  - the other file was created to showcase the ability to work on a different environment and do not impact production
+- open the terminal at the project folder and execute: `make setup;`
+- execute the project
+  - the vs code is already setup to launch the correct files, so you can find the runner at the top left on yours and choose `app-prod` and run it
+  - in android studio is necessary to setup the corrent files:
+    - Open your project in Android Studio.
+    - Go to Run -> Edit Configurations....
+    - Click on the + button at the top left of the Run/Debug Configurations dialog to add a new configuration.
+    - Select Flutter.
+    - In the Name field, enter the name of the configuration (e.g., "app-dev").
+    - In the Dart entrypoint field, enter the path to the Dart file you want to run (e.g., "lib/main_dev.dart").
+    - Click OK to save the configuration.

android/app/build.gradle

@@ -26,7 +26,7 @@ apply plugin: 'kotlin-android'
 apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
 
 android {
-    compileSdkVersion flutter.compileSdkVersion
+    compileSdkVersion 34
 
     compileOptions {
         sourceCompatibility JavaVersion.VERSION_1_8

android/build.gradle

@@ -1,12 +1,12 @@
 buildscript {
-    ext.kotlin_version = '1.3.50'
+    ext.kotlin_version = '1.9.23'
     repositories {
         google()
         mavenCentral()
     }
 
     dependencies {
-        classpath 'com.android.tools.build:gradle:4.1.0'
+        classpath 'com.android.tools.build:gradle:4.2.2'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
     }
 }
@@ -26,6 +26,6 @@ subprojects {
     project.evaluationDependsOn(':app')
 }
 
-task clean(type: Delete) {
+tasks.register("clean", Delete) {
     delete rootProject.buildDir
 }

android/gradle.properties

@@ -1,3 +1,9 @@
-org.gradle.jvmargs=-Xmx1536M
+# Fix made following instruction from: https://stackoverflow.com/a/69179997/10507546
+org.gradle.jvmargs=-Xmx1536M \
+--add-exports=java.base/sun.nio.ch=ALL-UNNAMED \
+--add-opens=java.base/java.lang=ALL-UNNAMED \
+--add-opens=java.base/java.lang.reflect=ALL-UNNAMED \
+--add-opens=java.base/java.io=ALL-UNNAMED \
+--add-exports=jdk.unsupported/sun.misc=ALL-UNNAMED
 android.useAndroidX=true
 android.enableJetifier=true

android/gradle/wrapper/gradle-wrapper.properties

@@ -3,4 +3,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-all.zip

assets/env/.env_dev

@@ -0,0 +1 @@
+yelpApiKey=YOUR_API_KEY_HERE

assets/env/.env_prod

@@ -0,0 +1 @@
+yelpApiKey=YOUR_API_KEY_HERE