Algorithm For Generating Trips
- Calculate the Min trip length to straight from Start -> End Location
- Generate a Bounding box around the Trip. Where if you were to drive along the perimeter of the box upwards or downwards it would take approximately the desired time to complete the trip.
- Slice the bounding area into slices where driving across the box would take approximately one day to drive
- Select
YStops from the Curated BigStops (see Big Stops) from each slice - Iterate through all Y*Days stops and determine the effect (See Effect Calculation) of removing the trip against a max delta. If delta is worse than max delta (it makes the trip worse by more than max delta ) remove it.
- Repeat (5) Until the trip meets the time and tag constraints designed by the user.
This is a curated list of cities and big locations where people would generally center a trip around. We will select various stops between these locations and every Big stop can have a bunch of small stops Ex: A big stop could be NYC and its small stops would be The Statue of Liberty and Central Park
This will calculate the current tag weight of a trip (the percentage stop type for each type) and the trip length To calculate the delta the trip before status will be known then the trip status will be calculated again without it having a given stop
in no particular order
- (UR-1) User will be able to sign in or sign up and create an account.
- (UR-2) User will be able to enter start, end, and required locations and TrekEngine will generate a route connecting them.
- (UR-3) User will be able to enter stop preferences and TrekEngine will display stops along the route that match the chosen preferences.
- (UR-4) User can choose routes from other users' previous trips.
- (UR-5) User's past trips can be displayed on their profile for other users to see.
- (UR-6) User will be able to rate trips they've been on as well as rate trips posted by other users.
- (UR-7) User will be able to create trips from scratch without TrekEngine input.
- (UR-8) User will be able to add friends
- (UR-9) User will be able to see friends trips
- (UR-10) User will be able to make trips public or private
- (SR-1) The User will need a internet enabled device with a browser and internet connection
- (SR-2) The Service will need to communicate with the Maps API to retrieve ratings and locations
- (SR-3) The Service will need to access to a database that will store all the User information as well as the Trips
- (SR-4) A google api account is needed to allow login and maps api requests.
- (SR-5) A script is needed to generate preliminary data
- (FR-1) from (UR-1) Assumptions: User has a google account, google api is valid (SR-4) : The user will be able to log in with their google account using OAuth.
- (FR-2) from (UR-2) Assumptions: database has valid trips needed to generate account (This will be auto generated for testing but eventually built up from other users ): There will be a form on the page where the user can enter information about their trips and the service will generate a route.
- (FR-3) from (UR-3) Assumptions: database has valid trips needed to generate account : There will be a form on the page where the user can enter trip preferences.
- (FR-4) from (UR-4) Assumptions: database is connected and has trips to view : The website will have a page where the service will serve routes along a path the user indicates.
- (FR-5) from (UR-5) Assumptions: database is connected: The user will be able to view other trips posted by other users on the website served by the service from the database.
- (FR-6) from (UR-6) Assumptions: database is connected: The user will be able to rate the trip of another user and other users will be able to view it when they look at the trip (see FR-5)
- (FR-7) from (UR-7) Assumptions: database is connected: The user will be able to create their own trips from scratch and it will be added to the database and associated with their account via the service.
- (FR-8) from (UR-10) Assumptions: database is connected: The user will be able to mark their trip as public or private disabling viewing by other users. However, the service will still be able to use the information in the route creating algorithm.
- (NF-1) from (UR-8) Assumptions: database is connected: The user will be able to follow other users adding them as a friend.
- (NF-2) from (UR-9) Assumptions: database is connected: The user will be able to filter and see only trips by those they added as friends.
- (NF-3) from (UR-10) Assumptions: database is connected: The user will be able to make their trips only available to friends or to no one.
- (UC-1) from (FR-1) Assumptions: URL https://www.trekengine.com is the URL: the user will be able to go to the website trekengine.com where they can login with google
- (UC-2) from (FR-2 and FR-3) The user will enter the start, required, and end location in a form as well as stop preferences and receive a generated trip
- (UC-3) from (FR-4) The user will be able to view trips by other people on the website and use it as a base for their trip (forking it )
- (UC-4) from (FR-5) The user will be able to see a list of trips by other people.
- (UC-5) from (FR-6) The user will have a form on every viewable trip where they can rate it.
- (UC-6) from (FR-7) The user will be able to create a trip from scratch. They should be able to search locations and add them along a path. Then the user will be able to finalize store, and edit this trip.
- (UC-7) from (FR-8) The user will be prompted to privatize their trips if they don't want other people looking at it.
- (US-1) from (UC-1) Implement OAuth with the google API
- (US-2) from (UC-1) After first login make a new entry in the database for the user
- (US-3) from (UC-2) Create layout for form that generates the user trips.
- (US-4) from (UC-2) Create API endpoint to send user data to the server to generate trip
- (US-5) from (UC-2) Write algorithm to find a path based on the user preferences.
- (US-6) from (UC-4) Create layout for users to browse other users' trips
- (US-7) from (UC-4) Make endpoint to retrieve trips given a certain filter to the user to view.
- (US-8) from (UC-3) Make API endpoint where users can add a trip with the specifications of another trip
- (US-9) from (UC-5) Add a rating button to each user viewable trip page where a user can enter a rating
- (US-10) from (UC-5) Add an endpoint where the rating can be updated. Each user rating will have to be individually stored in case the user wants to change their rating
- (US-11) from (UC-6) Create Layout where users can create a trip from scratch and an upload and edit button where they can save and change the information.
- (US-12) from (UC-6) Add a API endpoint where users can create a new trip
- (US-13) from (UC-6) Add a API endpoint where users can update a trip they have stored.
- (US-14) from (UC-6) Add a page where users can view their old trips and optionally edit them.
- (US-15) from (UC-7) Add a API endpoint where a user can view all the trips made by themselves.