Skip to content

Latest commit

 

History

History
145 lines (103 loc) · 4.37 KB

README.md

File metadata and controls

145 lines (103 loc) · 4.37 KB
Raw

Travel-Companion

Travel-Companion A web application which acts as a travel guide and fetches information about restaurants, accommodations , places of interest , weather in and around the user's location and also in places of their choice on the map. Focussed on the functionality and integration of multiple APIs, users have the ability to:

  • Look for Restaurants, Hotels, Places of Interest nearby based on their location
  • Filter on the basis of ratings of the place as per available
  • Search for any city to find the all of the above
  • See the current weather conditions of places over the map

Note: Travel Companion is still under development and some features may not be completely available yet. Feedbacks and Pull Requests are certainly welcome!.

Screenshots

Light Theme


Dark Theme


Plugins

Table of contents: The Application is built out with the help of the following:

The Application uses a number of APIs namely:

Run Locally

Clone the project

  git clone https://github.com/derpLLC/travel-companion.git

Go to the project directory

  cd travel_adv

Run the app

  npm install
  npm run start

Contributing

Want to contribute? See if you can find an issue you wanna close, then send a PR!

1. Fork this repository. Click on the symbol at the top right corner.

2. Clone the forked repository.

git clone https://github.com/<your-github-username>/travel-companion

3. Make a new branch

#Make a new branch to avoid conflicts with the main branch of repository
git checkout -b NewBranchName

4. Make changes in source code.

5. Stage your changes and commit

#Add changes to Index
git add .

#Commit to the local repo
git commit -m "<your_commit_message>"

6. Push your local commits to the remote repo.

git push

7. Create a PR !

8. Congratulations! Sit and relax, you've made your contribution to travel-companion project.

License

Copyright (c) 2021 Sounav Saha


Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the
Software without restriction, including without
limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice
shall be included in all copies or substantial portions
of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.