Skip to content

Developed a wearable smart pet collar that provides real-time GPS tracking and heart rate monitoring ensuring both security and health monitoring.

Notifications You must be signed in to change notification settings

FabioKoshy/PawTrack

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

67 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🐾 PawTrack

πŸ“Œ About the App

PawTrack is a smart and intuitive Flutter-based mobile application that helps pet owners monitor their pets’ health and location in real time. Designed with convenience in mind, PawTrack offers user authentication, multiple pet profiles, and customizable themes to make tracking your furry friend's well-being simple and effective.

Stay connected with your pet β€” wherever they go. 🐢🐱


✨ Features

βœ… Pet Health Tracking – Monitor key health metrics for each pet.
βœ… Real-Time Location Tracking – Live GPS tracking powered by Firebase.
βœ… User Authentication – Secure login and sign-up using Firebase Authentication.
βœ… Multiple Pet Profiles – Manage and track multiple pets from a single account.
βœ… Customizable Themes – Switch between dark and light themes for a personalized look.


πŸ›  Installation & Setup

πŸš€ Try It in the Browser!

No need to install anything! You can preview PawTrack instantly in your browser: Click here to run the app

The app will open in an emulator. Use the on-screen buttons to navigate through the Welcome and Login Screens.



πŸ–Ό UI Screenshots

Home Page Add Pet Profile Page
Home Add Pet Profile
Heart Rate Battery Settings Theme Toggle
Heart Rate Battery Theme
Heart Rate Threshold Location & Geofence
Threshold Location
Hardware Pet Wearing it
Hardware Harness attached to pet

πŸ”§ Prerequisites

Make sure you have the following installed:

  • βœ… Flutter SDK (>=3.27.0)
  • βœ… Dart SDK (>=3.0.0 <4.0.0)
  • βœ… Android Studio or VS Code (with Flutter & Dart plugins)
  • βœ… A configured Firebase project

βš™οΈ Setup Steps

1️⃣ Clone the Repository

git clone <repository-url>
cd pawtrack

2️⃣ Install Dependencies

flutter pub get

3️⃣ Set Up Environment Variables

PawTrack uses a .env file to securely load Firebase configuration data.

  • Request the .env file from a team member (via secure means like email or encrypted storage).
  • Place it in the root of the project directory.
  • Example structure:
FIREBASE_PROJECT_ID=your_project_id
FIREBASE_APP_ID=your_app_id
FIREBASE_API_KEY=your_api_key
FIREBASE_MESSAGING_SENDER_ID=your_sender_id
FIREBASE_STORAGE_BUCKET=your_bucket_url

⚠️ Do NOT commit .env to GitHub. It's already listed in .gitignore.

4️⃣ Run the App

flutter run
  • On first launch, you'll be greeted with the Welcome Page.
  • After login or sign-up, the Home Page will guide you through pet management.

πŸ“ Project Structure

pawtrack/
β”‚
β”œβ”€β”€ android/               # Android-specific files
β”œβ”€β”€ ios/                   # iOS-specific files
β”œβ”€β”€ lib/                   
β”‚   β”œβ”€β”€ auth/              # Firebase auth logic
β”‚   β”œβ”€β”€ components/        # Reusable UI widgets
β”‚   β”œβ”€β”€ pages/             # Screens (Home, Welcome, Profile, etc.)
β”‚   β”œβ”€β”€ services/          # Firebase and app logic
β”‚   β”œβ”€β”€ theme/             # Light/Dark mode settings
β”‚   β”œβ”€β”€ utils/             # Helpers and constants
β”‚   └── main.dart          # Entry point
β”œβ”€β”€ assets/                
β”‚   β”œβ”€β”€ images/            # App icons and logos
β”‚   └── .env               # Environment variables (ignored by Git)
β”œβ”€β”€ pubspec.yaml           # Dependencies
└── README.md              # Project documentation

πŸ” Firebase Configuration

  • Firebase integration is manually handled via environment variables.
  • Do not include the following sensitive files:
    • google-services.json
    • GoogleService-Info.plist
    • firebase_options.dart
    • firebase.json

πŸ›  For Firebase changes, contact the project admin for an updated .env file.


πŸ§ͺ Troubleshooting

πŸ’₯ Build Fails?

  • Make sure .env exists and is correctly populated.

πŸ” Authentication Not Working?

  • Double-check Firebase setup and that the firebase_auth version is compatible.

🎨 Theme Not Switching?

  • Ensure ThemeProvider is implemented and wired correctly with Provider.

🌱 Future Enhancements

🚧 The following features are planned for future development:

  • πŸ“ Live GPS Mapping
  • 🩺 Pet Health Logbook (vet visits, vaccinations)
  • πŸ”” Push Notifications for alerts (e.g., escaped pet, health warning)
  • 🧠 Behavior Analytics

🀝 Contributing

We welcome contributions! To get started:

  1. Fork the repository
  2. Create a branch:
git checkout -b feature/my-feature
  1. Commit your changes:
git commit -m "Describe the feature"
  1. Push and open a Pull Request:
git push origin feature/my-feature

βœ… Please describe your changes clearly in the PR!


πŸ“ License

This project is licensed under the MIT License. See the LICENSE file for details.


πŸ“¬ Contact

Have questions or suggestions? Reach out via GitHub Issues, or email the project maintainer.

πŸš€ Track smarter. Care better. With PawTrack. 🐾

About

Developed a wearable smart pet collar that provides real-time GPS tracking and heart rate monitoring ensuring both security and health monitoring.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 5