Skip to content

README.md

Latest commit

 

History

History
125 lines (95 loc) · 2.96 KB

README.md

File metadata and controls

125 lines (95 loc) · 2.96 KB

GuineaPal 🐹

GuineaPal is your all-in-one companion app for guinea pig care management. Whether you're a new owner or an experienced caregiver, GuineaPal helps you provide the best care for your furry friends.

Features

🏠 Complete Care Management

  • Pet Profiles: Create detailed profiles for each of your guinea pigs
  • Health Tracking: Monitor weight, mood, and medical records
  • Care Schedules: Set reminders for feeding, cleaning, and health checks
  • Family Tree: Track family relationships and breeding information
  • Waste Log: Monitor waste patterns for health insights

📸 GuineaGram

Share your guinea pig moments with the community through our built-in social feature.

📚 Comprehensive Care Guide

  • Housing requirements and setup tips
  • Diet and nutrition guidelines
  • Health and grooming advice
  • Exercise and play recommendations
  • Behavior understanding
  • Social needs and bonding guidance
  • Safe foods guide
  • New owner checklist

🏆 Achievement System

Stay motivated with achievements for:

  • Care consistency
  • Social engagement
  • Feeding schedules
  • Health management

Getting Started

Prerequisites

  • Node.js (Latest LTS version)
  • npm or yarn
  • Expo CLI
  • iOS/Android development environment setup for mobile deployment

Installation

  1. Clone the repository:

    git clone https://github.com/tashaingle/GuineaPal.git
cd GuineaPal

  2. Install dependencies:

    npm install

  3. Start the development server:

    npm start

  4. Run on your preferred platform:

    # For iOS
npm run ios

# For Android
npm run android

# For web
npm run web

Environment Setup

  1. Create a basic.env file in the root directory with your configuration:

    # Add your environment variables here

  2. For Firebase setup (optional but recommended for data sync):

    • Create a Firebase project
    • Add your Firebase configuration
    • Enable Authentication and Firestore

Features in Detail

Pet Management

  • Create and manage multiple pet profiles
  • Track weight history
  • Monitor mood and behavior
  • Log medical records and vet visits
  • Set care schedule reminders
  • Manage diet and feeding schedules

Health Monitoring

  • Weight tracking with charts
  • Health record management
  • Medication reminders
  • Vet appointment scheduling
  • Waste pattern monitoring

Social Features

  • Share photos on GuineaGram
  • Connect with other guinea pig owners
  • Share care tips and experiences

Contributing

We welcome contributions! Please read our contributing guidelines before submitting pull requests.

License

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

Support

For support, please:

  • Check our documentation
  • Join our community forum
  • Contact support at [support-email]

Acknowledgments

  • Thanks to all contributors
  • Special thanks to the guinea pig care community
  • Icon and image credits [Add credits here]