/Tripsage

Primary LanguagePythonMIT LicenseMIT

GitHub contributors GitHub language count GitHub closed pull requests License: MIT pre-commit Build Status Code style: black codecov DOI

TripSage

The only Itinerary planner, you will ever need

IMAGE ALT TEXT HERE


Hello! Welcome to TripSage!

Why TripSage?

Travelling to a new country can be stressful. Couple that with COVID, almost impossible. But the mental health benefits of travelling to new and exciting places doesn’t have to be so risky and expensive.
TripSage is a website that plans trips for users inside their home country. Simply, pick a destination state and cities, and you’ll be directed to your ideal trip. We have plans to include tags for: COVID -19 hotspots, whether the location is indoors, and the general population at that location to make sure users can practice safe travelling.

A new way of life doesn’t have to mean you can’t travel.
Explore the new of travelling with TripSage.

Tools used

We use Django, SQLite3, HTML, CSS, and Javascript.

New to Django?

Check out the basics: https://docs.djangoproject.com/en/3.1/intro/tutorial01/
The first 3 tutorials should be enough to get you started with our project.

Want a more in-depth look at server-side development?
Check out the basics: https://developer.mozilla.org/en-US/docs/Learn/Server-side
This tutorial also covers Django.

How to Run:

  1. Clone the project repo onto your local machine https://github.com/NischalKash/TripSage_SENG2020_Phase2.git
  2. Run pip install -r requirements.txt
  3. Execute manage.py using the command python3 manage.py runserver at 'Phase2_TripSage/tripsage/'. This runs the Django server such that we can open the webUI for the project on the browser.
  4. Next, open your browser and type in localhost:8000 in the search bar to open the webUI of the application.
  5. The UI typically looks as shown below and here you can enter the start and destination of your choice and look at the results based on your specifications.

Home page of TripSage App:

1

Route map for trip from Raleigh to Seattle

2

3

Result of adventurous places to visit between the jouney from Raleigh to Seattle

4

You can also review places to visit at any intermeditiary city on the journey

5

Project Structure:

(Disclaimer: Need some knowledge of Django to understand Project structure, please go through above resources if needed)
Phase2_TripSage/
  tripsage/
   tripsage/
    urls.py
   planner/
    templates
     directions.html
     home.html
     recommendations.html
    views.py
    functionaltesting.py


Phase 1 Completed Deliverables

  • Setup design and architecture of project (Django MVC)
  • Implemented call to Google Maps API to retrieve location details.
  • Setup Database Models required for the application.
  • Designed UI Mockups for the front end of the application.

Phase 2 Planned Deliverables

  • Improve the front-end of the design
  • Addition of style checkers for codebase
  • Adding Formatting guide and Code coverage to the code
  • Implementing core functionalities using the UI Mockups as a reference