chore: move few packages to dev dependencies, minor docs change

README.md

@@ -12,11 +12,7 @@ A Sudoku game made with Flutter, and integrated with Gemini.
 
 ## Getting Started 🚀
 
-This project contains 3 flavors:
-
-- development
-- staging
-- production
+This project contains 3 flavors: **development**, **staging**, **production**.
 
 To run the desired flavor either use the launch configuration in VSCode/Android Studio or use the following commands:
 
@@ -33,10 +29,6 @@ $ flutter run --flavor production --target lib/main_production.dart
 
 _\*Sudoku works on iOS, Android, and Web._
 
----
-
-## Setup 🧩
-
 The project is designed to be integrated with 3 different Firebase projects (depending upon flavor).
 
 > The default app instance can be initialized here simply by passing no "name" as an argument in both Dart & manual initialization flows. If you have a google-services.json file in your android project or a GoogleService-Info.plist file in your iOS+ project, it will automatically create a default (named "[DEFAULT]") app instance on the native platform. However, you will still need to call this method before using any FlutterFire plugins.
@@ -54,6 +46,15 @@ flutterfire config --out=lib/firebase_options_staging.dart --ios-bundle-id=dev.t
 flutterfire config --out=lib/firebase_options_production.dart --ios-bundle-id=dev.thecodexhub.sudoku --android-app-id=dev.thecodexhub.sudoku
 ```
 
+### Environment Variables 🚧
+
+The `API_BASE_URL` and `API_KEY` environment variables are used in this project. Checkout the [.env.example][env_example] file and copy the content to a `.env` file.
+
+- The `API_BASE_URL` represents the Base URL of the Backend Project which is responsible for creating sudoku and generating hints. Read more about it in the [dedicated repository][sudoku_backend].
+- The `API_KEY` represents a key used for authorization on the backend server. The frontend or the client is expected to send this key via **x-api-key** header.
+
+---
+
 ## Running Tests 🧪
 
 To run all unit and widget tests use the following command:
@@ -94,6 +95,8 @@ For more details on how to add strings, supported locales, and translations into
 [very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
 [very_good_analysis_link]: https://pub.dev/packages/very_good_analysis
 [very_good_cli_link]: https://github.com/VeryGoodOpenSource/very_good_cli
+[env_example]: ./.env.example
+[sudoku_backend]: https://github.com/thecodexhub/sudoku-backend
 [very_good_localizations]: https://cli.vgv.dev/docs/templates/core#working-with-translations-
 [flavours_flutterfire]: https://codewithandrea.com/articles/flutter-flavors-for-firebase-apps/
 [gradle_error_google_services]: https://stackoverflow.com/questions/33572465/gradle-errorexecution-failed-for-task-appprocessdebuggoogleservices

pubspec.lock

@@ -250,7 +250,7 @@ packages:
     source: hosted
     version: "2.0.5"
   fake_async:
-    dependency: "direct main"
+    dependency: "direct dev"
     description:
       name: fake_async
       sha256: "511392330127add0b769b75a987850d136345d9227c6b94c96a04cf4a391bf78"
@@ -306,7 +306,7 @@ packages:
     source: hosted
     version: "3.3.0"
   firebase_core_platform_interface:
-    dependency: "direct main"
+    dependency: "direct dev"
     description:
       name: firebase_core_platform_interface
       sha256: "3c3a1e92d6f4916c32deea79c4a7587aa0e9dbbe5889c7a16afcf005a485ee02"
@@ -638,7 +638,7 @@ packages:
     source: hosted
     version: "3.1.5"
   plugin_platform_interface:
-    dependency: "direct main"
+    dependency: "direct dev"
     description:
       name: plugin_platform_interface
       sha256: "4820fbfdb9478b1ebae27888254d445073732dae3d6ea81f0b7e06d5dedc3f02"
@@ -988,4 +988,4 @@ packages:
     version: "3.1.2"
 sdks:
   dart: ">=3.4.0 <4.0.0"
-  flutter: ">=3.22.0"
+  flutter: ">=3.22.1"

pubspec.yaml

@@ -1,20 +1,21 @@
 name: sudoku
-description: A Sudoku game made with Flutter, and integrated with Gemini
+description: A Sudoku game made with Flutter, and integrated with Gemini.
+homepage: https://github.com/thecodexhub/sudoku
 version: 1.0.0+1
+
 publish_to: none
 
 environment:
-  sdk: ^3.4.0
+  sdk: ">=3.0.0 <4.0.0"
+  flutter: 3.22.1
 
 dependencies:
   bloc: ^8.1.3
   dio: ^5.5.0+1
   envied: ^0.5.4+1
   equatable: ^2.0.5
-  fake_async: ^1.3.1
   firebase_auth: ^5.1.3
   firebase_core: ^3.3.0
-  firebase_core_platform_interface: ^5.2.0
   flutter:
     sdk: flutter
   flutter_bloc: ^8.1.4
@@ -25,19 +26,21 @@ dependencies:
   intl: ^0.19.0
   json_annotation: ^4.9.0
   loading_indicator: ^3.1.1
-  plugin_platform_interface: ^2.1.8
   rxdart: ^0.28.0
   shared_preferences: ^2.2.3
 
 dev_dependencies:
   bloc_test: ^9.1.6
   build_runner: ^2.4.11
   envied_generator: ^0.5.4+1
+  fake_async: ^1.3.1
+  firebase_core_platform_interface: ^5.2.0
   flutter_test:
     sdk: flutter
   json_serializable: ^6.8.0
   mockingjay: ^0.5.0
   mocktail: ^1.0.3
+  plugin_platform_interface: ^2.1.8
   very_good_analysis: ^6.0.0
 
 flutter: