Skip to content

Dev-muse/Jaunt

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

22 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐ŸŒ Jaunt - Your Travel Companion

Jaunt Logo

Discover the world's best restaurants, hotels, and attractions with real-time weather information

React Material-UI License

Live Demo โ€ข Report Bug โ€ข Request Feature


๐Ÿ“– About The Project

Jaunt is a modern, responsive travel advisor application that helps explorers discover amazing places around the world. Whether you're searching for the perfect restaurant, a comfortable hotel, or exciting attractions, Jaunt provides detailed information, ratings, and real-time weather data to help you make informed decisions.

โœจ Key Features

  • ๐Ÿ—บ๏ธ Interactive Google Maps - Seamlessly explore locations with a fully interactive map interface
  • ๐Ÿ“ Geolocation Support - Automatically detects and centers on your current location
  • ๐Ÿ” Smart Autocomplete Search - Powered by Google Places API for instant location search
  • ๐Ÿจ Multiple Categories - Browse restaurants, hotels, and attractions in any area
  • โญ Rating Filters - Filter places by minimum rating (3.0, 3.5, 4.0, 4.5+)
  • ๐ŸŒค๏ธ Real-Time Weather - View current weather conditions for any location
  • ๐Ÿ“ฑ Fully Responsive - Optimized experience across desktop, tablet, and mobile devices
  • ๐ŸŽจ Beautiful UI - Clean, modern interface built with Material-UI
  • ๐Ÿ–ผ๏ธ Rich Place Details - View photos, ratings, reviews, pricing, and contact information
  • ๐Ÿ”„ Dynamic Updates - Results update automatically as you pan and zoom the map

๐Ÿš€ Live Demo

Experience Jaunt in action: Live


๐Ÿ› ๏ธ Built With

Frontend Framework:

  • React - JavaScript library for building user interfaces
  • Material-UI - React UI framework

APIs & Services:

Additional Libraries:


๐Ÿ“‹ Prerequisites

Before running this project, make sure you have:

  • Node.js (v14.0 or higher) - Download
  • npm or yarn package manager
  • API Keys (see setup instructions below):
    • RapidAPI account (for Travel Advisor & Weather APIs)
    • Google Cloud account (for Maps & Places APIs)

โš™๏ธ Installation & Setup

1๏ธโƒฃ Clone the Repository

git clone https://github.com/Dev-muse/Jaunt.git
cd Jaunt

2๏ธโƒฃ Install Dependencies

npm install

or if you prefer yarn:

yarn install

3๏ธโƒฃ Get Your API Keys

RapidAPI Keys (Travel Advisor & Weather)

  1. Sign up at RapidAPI
  2. Subscribe to Travel Advisor API
  3. Subscribe to Open Weather Map API
  4. Copy your RapidAPI key from the dashboard

Google Maps API Key

  1. Go to Google Cloud Console
  2. Create a new project (or select an existing one)
  3. Enable the following APIs:
    • Maps JavaScript API
    • Places API
    • Geocoding API
  4. Navigate to Credentials โ†’ Create Credentials โ†’ API Key
  5. Copy your API key
  6. Important: Restrict your API key to prevent unauthorized use

4๏ธโƒฃ Configure Environment Variables

Create a .env file in the root directory:

REACT_APP_RAPIDAPI_KEY=your_rapidapi_key_here
REACT_APP_GOOGLE_MAPS_API_KEY=your_google_maps_api_key_here

Security Note: Never commit your .env file to version control. It's already included in .gitignore.

5๏ธโƒฃ Start the Development Server

npm start

The application will automatically open at http://localhost:3000


๐Ÿ“ Project Structure

jaunt/
โ”œโ”€โ”€ public/
โ”‚   โ”œโ”€โ”€ index.html              # HTML template
โ”‚   โ”œโ”€โ”€ favicon.ico
โ”‚   โ””โ”€โ”€ manifest.json
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ api/
โ”‚   โ”‚   โ””โ”€โ”€ index.js            # API integration (Travel Advisor & Weather)
โ”‚   โ”œโ”€โ”€ assets/
โ”‚   โ”‚   โ””โ”€โ”€ logo.svg            # Application logo
โ”‚   โ”œโ”€โ”€ components/
โ”‚   โ”‚   โ”œโ”€โ”€ Header/
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Header.jsx      # Search bar with autocomplete
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ styles.js       # Component styles
โ”‚   โ”‚   โ”œโ”€โ”€ List/
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ List.jsx        # Places list with filters
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ styles.js
โ”‚   โ”‚   โ”œโ”€โ”€ Map/
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ Map.jsx         # Interactive Google Map
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ mapStyles.js    # Custom map styling
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ styles.js
โ”‚   โ”‚   โ””โ”€โ”€ PlaceDetails/
โ”‚   โ”‚       โ”œโ”€โ”€ PlaceDetails.jsx # Individual place card
โ”‚   โ”‚       โ””โ”€โ”€ styles.js
โ”‚   โ”œโ”€โ”€ App.js                  # Main application component
โ”‚   โ””โ”€โ”€ index.js                # Application entry point
โ”œโ”€โ”€ .env                        # Environment variables (create this)
โ”œโ”€โ”€ .gitignore
โ”œโ”€โ”€ package.json
โ””โ”€โ”€ README.md

๐ŸŽฎ How to Use

  1. Allow Location Access
    When prompted, grant the application permission to access your location for automatic positioning.

  2. Explore the Map
    Pan, zoom, and navigate the interactive map to discover places around the world.

  3. Search for Locations
    Use the search bar at the top to find specific cities, addresses, or points of interest.

  4. Filter Your Results

    • Type: Choose between Restaurants, Hotels, or Attractions
    • Rating: Set a minimum rating filter (e.g., show only 4+ star places)
  5. View Place Details
    Click on map markers or list items to see detailed information including:

    • Photos
    • Ratings and reviews
    • Price range
    • Contact information
    • Rankings
  6. Check the Weather
    View real-time weather conditions for the current map location.


๐Ÿ“œ Available Scripts

Command Description
npm start Runs the app in development mode at http://localhost:3000
npm build Builds the app for production to the build folder
npm test Launches the test runner in interactive watch mode
npm eject Ejects from Create React App (โš ๏ธ irreversible)

๐Ÿ› Troubleshooting

Map not loading?

  • Verify your Google Maps API key is correct in .env
  • Ensure Maps JavaScript API is enabled in Google Cloud Console
  • Check browser console for API errors

No places showing up?

  • Confirm your RapidAPI key is valid and has active subscriptions
  • Check that you haven't exceeded API rate limits
  • Try zooming in closer to a specific location

Location not detecting?

  • Allow location permissions in your browser
  • Check that your browser supports geolocation
  • Try manually searching for a location

๐Ÿค Contributing

Contributions make the open-source community an amazing place to learn and create! Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

๐Ÿ“„ License

Distributed under the MIT License. See LICENSE for more information.


๐Ÿ‘จโ€๐Ÿ’ป Author

Rahman Muse


๐Ÿ™ Acknowledgments


๐Ÿ“ง Support

If you encounter any issues or have questions:


โญ Star this repository if you find it helpful!

Made with โค๏ธ by Dev-muse

About

Travel advisor app that allows the user to search for top restaurants, hotels and attractions from across the globe.

Resources

Stars

Watchers

Forks

Contributors