Shoe App Documentation

Shoe App Documentation

======================

Introduction

—–——-

This documentation explains the usage and configuration of the shoe-themed Flutter application. The purpose of this application is to provide users with information and visual display of shoes. The GetX package is used for state management and navigation within the application.

Installation

—–——-

• 1. Make sure Flutter is installed. Refer to the [Flutter Installation Guide](https://flutter.dev/docs/get-started/install) for instructions on how to install Flutter.
• 2. To install project dependencies, follow these steps:

  – Open the `pubspec.yaml` file.
  – Add the following dependencies to the `dependencies` section:

  
      `dependencies:
        flutter_credit_card: ^3.0.4
        flutter_native_splash: ^2.2.16
        flutter_staggered_animations: ^1.1.1
        flutter_svg: ^2.0.7
        get: ^4.6.5
        google_fonts: ^4.0.4
        hive_flutter: ^1.1.0
        http: ^1.1.0
        palette_generator: ^0.3.3+2
        path: ^1.8.2
        path_provider: ^2.0.11
        shimmer: ^3.0.0
        smooth_page_indicator: ^1.0.0+2
        sqflite: ^2.2.2
        badges: ^3.1.1
        cached_network_image: ^3.2.3
        carousel_slider: ^4.2.1
        cupertino_icons: ^1.0.2
        drop_shadow: ^0.1.0
        dynamic_color: ^1.5.4`
        

• 3. To update the dependencies, run the following command in the terminal:

  bashCopy code

  `flutter pub get`

Project Structure

—–—–——-

The application project follows the following file and folder structure:

`- lib
 - controllers
 - shoe_controller.dart
    - ...
  - models
    - shoe.dart
  - screens
    - home_screen.dart
 - product_screen.dart
  - widgets
    - shoe_card.dart
 - ...
 - main.dart
- assets
 - images
 - shoes
 - shoe1.jpg
 - shoe2.jpg
 - ...
 - fonts
 - ...
- pubspec.yaml`

• – `lib/controllers`: Contains the controller classes used within the application. State management with GetX is handled in this section.
• – `lib/models`: Contains the shoe model and other data models.
• – `lib/screens`: Contains the application screens.
• – `lib/widgets`: Contains reusable widgets.
• – `lib/main.dart`: The entry point of the application.
• – `assets/images`: Contains the shoe images.
• – `assets/fonts`: Contains the fonts used in the application.
• – `pubspec.yaml`: Defines the dependencies and assets of the project.

Core Features

—–—––

The shoe application provides the following core features:

• 1. Home Screen:
  • – Slideshow displaying the shoe collection.
  • – Filtering options by categories.
  • – List view of popular shoes.
• 2. Shoe Details:
  • – Displays detailed information of a selected shoe.
  • – Slide show of shoe images.
  • – Price and stock information.

Dependencies

—–——-

The application utilizes the following dependencies:

• – `flutter_credit_card`: Simplifies credit card form and validation.
• – `flutter_native_splash`: Configures the native splash screen for the application.
• – `flutter_staggered_animations`: Creates animated transition effects.
• – `flutter_svg`: Supports SVG images in Flutter.
• – `get`: State management and navigation package.
• – `google_fonts`: Provides access to Google fonts.
• – `hive_flutter`: Database management package.
• – `http`: Handles HTTP requests.