Skip to content

Latest commit

 

History

History
311 lines (216 loc) · 13 KB

README.md

File metadata and controls

311 lines (216 loc) · 13 KB

🏞️ BuddyTrail

Welcome to BuddyTrail – your ultimate travel companion! 🌍✈️ Whether you're planning a family vacation 👨‍👩‍👧‍👦 or a trip with friends 👫, BuddyTrail helps you discover and explore amazing destinations 🏖️🏰, find the best hotels 🏨, and book affordable flights 💺 with ease.


🌟 Stars 🍴 Forks 🐛 Issues 🔔 Open PRs 🔕 Close PRs 🛠️ Languages 🌐 Contributors
Stars Forks Issues Open Pull Requests Close Pull Requests GitHub language count GitHub contributors

This project is now OFFICIALLY accepted for

Event Logo Event Name Event Description
GSSoC 24 GirlScript Summer of Code Extended 2024 GirlScript Summer of Code Extended is a month-long Open Source Program conducted by GirlScript Foundation. It is an initiative to bring more beginners to Open-Source Software Development.
Hacktoberfest 2024 Hacktoberfest 2024 Hacktoberfest is a month-long celebration of open source software run by DigitalOcean, GitHub, and Twilio. It encourages contributions to open source projects and promotes a global community of developers.

📋 Table of Contents

📸 Website Preview

Recording.2024-10-19.174753.mp4

Screenshot 2024-10-19 143805

Screenshot 2024-10-19 143906

Screenshot 2024-10-19 143959


🚀 Features

🗺️ Interactive Travel Map: Explore popular destinations across India and around the world. Click on markers to learn more about each location.

🌙🌞 Dark & Bright Mode: Switch between dark and bright modes for a comfortable browsing experience, day or night.

🏨 Hotel Finder: Find the best hotels at affordable rates, handpicked to suit your budget and preferences.

✈️ Flight Booking: Book flights at the best prices, with options tailored to your travel needs.

📝 Travel Blog: Read tips, guides, and personal stories from seasoned travelers.

🌐 Multi-Language Support: View the website in multiple languages, catering to a global audience.

⭐ User Reviews and Ratings: Read and leave reviews for destinations, hotels, flights, and activities.


🛠️ Technologies Used

📝 HTML/CSS: For building and styling the website structure.

⚙️ JavaScript: For interactive features like the map and mode toggling.

🗺️ Google Maps API: For displaying the interactive travel map.

📱 Responsive Design: The website is fully responsive and works on all devices.


📡 API Documentation

Overview

The BuddyTrail API allows you to interact with travel data, including destinations, hotels, and flights.

Endpoints

🌍 Get Destinations

  • URL: /api/destinations
  • Method: GET
  • Description: Fetch a list of popular travel destinations.

🏨 Get Hotels

  • URL: /api/hotels
  • Method: GET
  • Description: Retrieve available hotels for a specified destination.

✈️ Book Flight

  • URL: /api/book-flight
  • Method: POST
  • Description: Book a flight with the provided travel details.

Usage Example

curl -X GET "https://api.buddytrail.com/api/destinations"

📜 Response Format

All responses are in JSON format. Ensure to handle errors appropriately.

🛤️ Project Roadmap

Our roadmap outlines the future features and enhancements planned for BuddyTrail. We are committed to continuously improving your travel experience! 🚀

Quarter Feature Description Status
Q4 2024 🌍 Enhanced Destination Search Introduce advanced filters and suggestions for popular travel destinations. In Progress
Q1 2025 ✈️ Flight Comparison Tool Allow users to compare flight options side-by-side to find the best deals. Planned
Q2 2025 🏨 Hotel Booking Integration Integrate with hotel booking platforms for real-time availability and pricing. Planned
Q3 2025 📱 Mobile App Launch Launch a mobile app version of BuddyTrail for on-the-go planning and booking. Planned
Q4 2025 🌐 Multi-Language Support Expand language options to cater to a broader international audience. Planned
Q1 2026 📖 Travel Blog Feature Implement a community-driven travel blog where users can share experiences and tips. Future

Stay tuned for updates as we work to bring these features to life! 🎉

🎉 Welcome Contributors!! 👨‍💻👋

Join the list. We are waiting
Here's how you can contribute to the repository:

  1. Fork this Repository 🍴
  2. Clone to your local machine 🧩 using:
git clone https://github.com/Your-Username/BuddyTrail.git
  1. Create a new branch:
git branch -c "Feature-Name"
  1. Navigate to the branch:
git checkout Feature-Name
  1. Add changes and Commit:
git commit -m "Add Changes message"
  1. Push to the branch:
git push origin Feature-Name
  1. Submit Pull Request

We welcome all contributions to improve BuddyTrail! If you would like to contribute, please follow the Contributing.md for more details on how to get started.

To maintain quality and consistency, please adhere to the following guidelines:

  1. Code Style: Follow the coding style used throughout the project. Clean, readable code with comments is always appreciated.
  2. Commits: Write meaningful commit messages.
  3. Pull Requests: Make sure PRs are focused, well-explained, and reference any issues they address.
  4. Testing: Ensure that your changes are well-tested locally and don’t break existing functionality.

Project-strucutre 📁

You can find the project structure in the Project Structure file. It contains the details of the project structure and the files present in the project. It will help you to understand the project structure better. 🗂️

👥 Team

Priya Ghosal
Priya Ghosal
Project Admin
LinkedIn Discord Twitter GitHub

For any inquiries or feedback, please contact. Happy Contributing 🫡

Our Contributors

Thank you for contributing to our repository

↳ Stargazers

Stargazers repo roster for @PriyaGhosal/BuddyTrail

↳ Forkers

Forkers repo roster for @PriyaGhosal/BuddyTrail

Star History Chart

⭐️ Support the Project

If you find this project helpful, please consider giving it a ⭐ on GitHub! Your support helps to grow the project and reach more contributors.

Thanks for reading!!!