Skip to content

devlup-labs/travel_companion

Repository files navigation

Travel Companion

Open in Visual Studio Code Contributors Forks Stars Build Status License

A Flutter-based app to connect travelers and simplify trip planning.

FeaturesInstallationUsage GuidelinesContributing

🌟 Overview

Travel Companion is a social travel app that enables users to find and connect with travelers heading to similar destinations. Users can post trips, search for trips posted by others, send requests to join, and exchange contact information upon request acceptance. The app is designed for ease of use with a secure and efficient backend powered by Firebase.

🚀 Key Features

  • 🔐 Google Sign-In: Secure and seamless authentication.
  • 📝 Post Trips: Create a travel plan and share it with others.
  • 🔍 Search Trips: Find journeys posted by other travelers.
  • 🤝 Request to Join: Send and manage requests to join trips.
  • Accept or Reject Requests: Manage requests and exchange contact information upon acceptance.

🌈 Why Travel Companion?

  • Simplified Travel Planning: Quickly find and connect with like-minded travelers.
  • User-Friendly: Intuitive design ensures a seamless experience.
  • Efficient Communication: Contact information is securely shared upon mutual agreement.

📋 Prerequisites

  • Flutter (3.0 or higher)
  • Firebase setup with credentials
  • Git (optional)

🔧 Installation

Step-by-step guide
  1. Clone the repository:
git clone https://github.com/Asharma538/travel_companion.git
cd travel_companion
  1. Set up Firebase:

    • Create a Firebase project.
    • Download the google-services.json file for Android.
    • For iOS, download the GoogleService-Info.plist file.
    • Place them in the respective directories.
  2. Install dependencies:

flutter pub get
  1. Run the app:
flutter run

🎮 Usage Guidelines

  • Sign In: Use Google to log in securely.
  • Post a Trip: Share your travel plans with the community.
  • Search Trips: Explore trips posted by other users.
  • Send Requests: Request to join a trip that aligns with your plan.
  • Manage Requests: Accept or reject requests. Upon acceptance, contact details are shared securely.

🔑 Example Workflow

  1. Log in with Google.
  2. Post your trip details.
  3. Search for trips that match your preferences.
  4. Send a request to join a trip or manage requests received.
  5. Exchange contact information with fellow travelers upon mutual agreement.

🤝 Contributing

Contributions are welcome! Here's how you can help:

  1. Fork the repository.
  2. Create a feature branch (git checkout -b feature/NewFeature).
  3. Commit your changes (git commit -m 'Add new feature').
  4. Push to the branch (git push origin feature/NewFeature).
  5. Open a Pull Request.

📜 License

Travel Companion is open-source, released under the MIT License. See LICENSE for details.

🙏 Acknowledgments

Happy traveling! ✈️🧳