Restaurant Tour - Refactor with clean architecture

[Darjc]

``

## Setup Instructions

• Install dependencies: Run fvm flutter pub get to install required packages.
• Create a .env file: In your project root, create a .env file containing this line:

YELP_API_KEY=<your_Yelp_API_key>
YELP_API_URL=https://api.yelp.com/v3/graphql

• Replace <your_Yelp_API_key> with your actual Yelp API key.

• Reference .env for running:

  • Terminal: Use fvm flutter run -d <your_device> --dart-define-from-file .env
  • VS Code: Modify your launch.json (refer to Flutter documentation for details). Here's an example structure:

JSON

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "app",
      "request": "launch",
      "type": "dart",
      "args": [
        "--dart-define-from-file",
        ".env"
      ]
    }
  ]
}

## Running Tests

• Unit & Widget Tests: Use flutter test ./test for unit and widget testing.
• Integration Tests: Execute flutter test ./integration_test -d <your_device> for integration tests (requires a connected device).

## Code Structure

The application code is organized in a layered structure within the lib folder:

• common: Reusable classes across different layers.
• data: Handles data access, including shared preferences and API calls.
• di: Establishes dependency injection using GetIt.
• domain: Contains business logic defined by interfaces (contracts).
• models: Represents data structures with JSON annotations (e.g., Restaurant model).
• presentation: Manages data flow using BLoC patterns (business logic components) that interact with the view and domain layers.
• view: Holds UI components like pages and widgets.

## Observations

• Prioritized Coverage: Instead of aiming for 100% coverage, we've focused on testing core use cases and the repository layer for optimal app functionality.
• Comprehensive Testing Suite: The app utilizes unit tests, widget tests, and integration tests.
• Integration Test Data Swapping: To bypass API call limitations during testing, a testMode flag is implemented in di.dart to switch the data source for restaurants.

Thank you (: