Skip to content

PlanAway is an application that helps travelers plan their itinerary in the most optimal route saving time and money. It relies on Google Map API to get details of the location of a user, the stopovers, and the routes. Travel Advisor from Rapid API was used to fetch and suggest places of visit surrounding the users' originating location.

License

Notifications You must be signed in to change notification settings

udeaghad/PlanAway

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

image

PlanAway 🏩

PlanAway is an application that helps travelers plan their itinerary in the most optimal route saving time and money. It relies on Google Map API to get map details of the originating location of a user, the stopovers, and the routes. Travel Advisor from Rapid API was used to fetch restaurants and attractive places of visit surrounding the users' originating location. We created an algorithm to split these activities or selected places into the number of days for their visits based on distances.

Project Documentation 📄

Team members

Built With 🛠️

  • Programming Languages: TypeScript, JavaScript, HTML, CSS.
  • Frameworks: React, Redux, Material UI.
  • External APIs: Google Map API, Travel Advisor API
  • GitHub Linters.
  • Code Editor: VS Code.

Trello Board

  • Click this link to view the Trello board

Figma Design

  • Click this link to view the Figma design file

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  • A web browser like Google Chrome.
  • A code editor like Visual Studio Code with Git and nodejs.
  • You can check if Git is installed by running the following command in the terminal.
  • $ git --version
  • Clone the repo from here.
  • $ git clone https://github.com/udeaghad/PlanAway.git

Usage

Run locally

  • Make your way to the correct directory by running this command:
  • $ cd PlanAway
  • Run npm install to install the dependencies in the local node_modules folder.
  • Run npm start to start the app in the browser.
  • Open http://localhost:3000 to view it in the browser.

Run tests

  • Run npm test to run the tests.

Authors

👤 Dozie Udeagha

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

  • Co.Lab for the opportunity to work on this project.
  • Google Map API for providing free access to their API.
  • Rapid API for providing free access to their Travel Advisor API.

📝 License

This project is MIT licensed.

About

PlanAway is an application that helps travelers plan their itinerary in the most optimal route saving time and money. It relies on Google Map API to get details of the location of a user, the stopovers, and the routes. Travel Advisor from Rapid API was used to fetch and suggest places of visit surrounding the users' originating location.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages