PetCoin

Project Structure and Installation

This project is built with Flutter and adheres to a common structure for organization and maintainability.

File Organization

• lib: This directory contains all the source code for your Flutter application.
  • firebase_options.dart (Optional): Stores Firebase configuration details (keep this file private).
  • main.dart: The entry point of the application.
  • models (Optional): Dart classes representing data models used in the app.
  • screens: Contains all the UI screens of the application (e.g., login_screen.dart, home_page.dart).
  • services (Optional): Houses classes for handling business logic and interacting with external services.
  • widgets: Reusable UI components used throughout the app.
  • widget_tree.dart (Optional): Can be used to define the overall widget hierarchy of your app.

Note: The models, services, and widget_tree.dart files are optional and can be added as your project grows in complexity.

Installation

1. Prerequisites: Ensure you have Flutter installed on your development machine following the official guide: https://docs.flutter.dev/get-started/install
2. Clone the project: Clone or download this project repository to your local machine.
3. Dependencies: Run flutter pub get in the project directory to install the required dependencies listed in pubspec.yaml.
4. Firebase Configuration (Optional): If you plan to use Firebase features, replace the placeholder values in firebase_options.dart with your project's specific configuration details obtained from the Firebase console.

Running the App:

• Open a terminal in the project directory.
• Run flutter run to launch the app on a connected device or emulator.

This should get you started with developing your Flutter project!