Plan and schedule trips with an visual overview. Project for CSCI 187: Design and Management of Software at SCU (Santa Clara University).
Home Page: https://youtinerary.dlee.dev/
License: MIT License
Web application that provides easy scheduling and visual overviews of trips. Project for CSCI 187: Design and Management of Software at SCU. YOUtinerary is available at YOUtinerary.dlee.dev.
To get started developing on or to run a local instance of YOUtinerary, follow the wiki pages below.
To learn more about YOUtinerary, the following wiki pages provide high level descriptions and motivations for the technology stack and information about other technology used.
MIT.
![dependabot-preview[bot] avatar](https://avatars.githubusercontent.com/in/2141?v=4 "dependabot-preview[bot]")
use eslint instead of tslint since tslint will be deprecated soon
using tslint
vscode settings for js/ts/react should be saved in the repository along with recommended extensions:
"eamodio.gitlens", "ms-vscode.vscode-typescript-tslint-plugin", "esbenp.prettier-vscode", "yzhang.markdown-all-in-one"
n/a
Map visualizer shows all locations in the agenda
n/a
very basic form of sharing by sending data encoded in the url
Location bias is where user is located, results are biased to current location. Could just hardcode this to be at scu who cares
Location bias is where api server is located, searching stuff gives results in other locations
Not too many Google Maps API requests
Majority of API requests are from from the GH actions key. ~400 vs ~50
Map bounds and centre are correct.
minor issue is the bounds load differently when you go to menu and come back vs refresh. refresh displays it right but it's small
Also, map centering is inconsistent, sometimes is set to SCU with other locations out of bound.
Delete option for events
can't delete events
Use callback form for all setState()s in Plan.tsx
State is updated with potentially stale values
More info: https://lgtm.com/rules/1819283066/
Clear button for all events next to plan title
no clear button, users need to clear each one individually
no deploys when changes in non-web packages
deploys for all changes
Users can view route data from Google Maps API
n/a
Clear all event button hides when plan is empty
Clear all button always shows
Users can add, edit, and remove events
n/a
web / api packages should use the same api response data so a shared interface should be used (additional models package)?
no shared interfaces / packages
New events are rounded to the closest 15 min.
Also still needs decision on what the default time should be. Current time doesn't really seem like a good default, so maybe the time right after the previous event? Additionally, the first event created should have a sensible default, maybe some time in the morning around 10AM.
Currently time selections for minutes are set to every 15 min (0, 15, 30, 45), but new events use the current time.
Builds off #123, uses Geolocation API to get user's actual location for locationBias. Or, uses Mozilla Location Services API via api request on client side (though this isn't recommended).
Using Geolocation API, however, requires explicit permission from clients to use their location which many times is denied.
Hardcoded to SCU coordinates.
Users can view their own trip route and stops on a map overview
n/a
Same as #82 but deploys to production environment on new releases (tags)
n/a
tsc & tslint configs should be same across both api and web
No consistent configs
Staging deployments via GitHub actions + docker for all changes on master
n/a
nav active colours are the original blue (primary) colour
Key file: YOUtinerary/packages/web/src/styles/style.less
https://ant.design/components/grid/
it's currently white
Event times adjust when drag and dropped. e.g. moving an event before another should change the time to be before the other event
No association between position and times
Get new directions data via api when event locations change, removing old route and adding new
Doesn't get new directions unless page refreshed, componentDidUpdate() in Plan.tsx seems to give the current state as prevstate. Could possibly be issues with state being array and some reference comparisons.
This also happens:
Persisted data should be in format that stores and supports multiple days / plans (even if it doesn't support it yet). Need to consider class objects that have to be recreated when deserialized.
ex:
{
"plans": [ // multiple different plans
{
"metadata": { // plan data
"name": "plan name"
},
"events": [] // multiple days
}
]
}Persisted data only has 1 itinerary data (title) and 1 plan (list of events)
Users should be able to set or view events as passed, either manually with a checkbox type action or automatically based on time
n/a
Route is either refetched on refresh or saved & restored from the user's browser. Preferably stored in the browser along with the plan data to prevent excessive API calls (even if it's cached, minimize latency).
Route is not shown when page is refreshed. Also route is not persisted or saved anywhere.
Refresh -> Route gone
Navigating home and back to Plan page -> Route is loaded
When user first starts an itinerary, an example event should be added. This could have information in description like a small explanation of what you can do.
e.g: This is an example event! You can add or change descriptions and titles by clicking the edit button at the side. + search help when it's implemented, etc. etc.
Empty itinerary on first load
Make dockerfile for easier API deployment
n/a
Undo after delete, clear, etc
no undo
Available options are 'driving', 'walking', 'bicycling', 'transit'. User should have buttons for each respective method. The shown route should change to the respective one when the transportation method changes
n/a
Event data should be passed to map via props or shared state
n/a
Users can make multiple itineraries for the same days as different plan options
n/a
Prevent users from exceeding API quotas and incurring extra costs
n/a
Users shouldn't be able to spam api requests
n/a
Text covers full page
Key file: YOUtinerary/packages/web/src/pages/index.tsx
https://ant.design/components/grid/
Text only spans half on mobile (don't really need it to be half)
Users can have itineraries that span multiple days
n/a
Users can search for businesses, places, etc via Google Maps API or equivalent. It should provide addresses and additional information.
n/a
uses @google/maps Yarn dep and the corresponding typedefs @types/google__maps (types are a dev dependency)
uses googleapis dependency which doesn't have maps support
Map shows on mobile, either below plan or with a toggle button
map doesn't show
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.