Note this repo is archived and won't be updated, so some things might be out of date with current conventions. Keeping this around as an artifact of how much I've grown as a developer.
Summary: The BikeBright web application provides users a simple, mobile friendly method for making their biking experience safer and more enjoyable in the city of Portland, Oregon. This is done by providing the user map views that show where bike thefts occur and where users can lock their bikes. The site is hosted through heroku at the URL: https://bikebright.herokuapp.com/index.html
Application Description: Page Layout: The BikeBright application consists of three interlinked pages: Home, Map, and Discuss. Each of the pages are easy to navigate to, with a common nav bar placed at the top of each page. -Home -Map -Discuss
Page Persistence: The site leverages "page.js" to maintain and implement persistence. Controllers for the Map and Discuss page are referenced by page.js when the page() is called.
User Input: Two pages have user input: Map and Discuss.
Map: The map page view can be modified with user input/interaction. User input is via text input and button clicks. The text input field is used by the user to enter an address on the map that they want to view. The text field has auto completion built in. This helps the user locate a specific address more efficiently. When a address is added, the map will zoom to that location.
There are also three buttons, that the user can click on to provide more data on the map.
-Current Location: When the user clicks on this button, the map will zoom into the users current location.
-Crime Data: When a user clicks on this button, a heatmap will be displayed on the map showing bike theft incidents in Portland, Oregon.
-Show Parking: When A user clicks on this button, markers will shown on the map for secure parking locations in Portland, Oregon.
Discuss:
API Integration: The Map and Discuss pages are dependent on APIs for functionality. The Map page leverages the google.map API to show a default map and to modify what is displayed on the map based on user input. The Discuss page uses the disqus API to implement a blog site which is hosted remotely, but displayed locally.
Data Maintenance and Support:
- The application depends on data contained in the Bicycle_Parking_pdx.geojson to mark bike parking locations on a map. This data should be updated quarterly, on the first working day of the first month of the calendar quarter (Jan, April, July, Oct). For detailed instructions on how to download, convert and store this data, reference the following document in the docs folder: Bike Parking Location Data Configuration.docx
- The application depends on data contained in the heatMapData.js file. This is SIMULATED data and does not have to be updated. The application roadmap calls for the replacement of this data with an api supported real time data source or actual data file that we will maintain on the server. This dat asource is not publicly available at this time.
- Originally, the application did was designed to display zip code boundaries. With the implementation of a heat map, we will no longer display zip code data. In the future, there may be a need for this capability, so the instructions used for this data will remain. Reference the following file in the docs folder for details on how to access, download, convert, and store the zip code data: ZipCodeDataConfiguration.docx.
- Originally, the application was showing crime data by zip code. The stolenBike.json file contained the crime related data. We are no longer using this data, and are instead using a heat map solution.We will leave the instructions for this data in the docs folder, just in case it is needed in the future. The doc is titled: CrimeDataConfigurationcopy.docx