-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
152 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,32 +2,171 @@ | |
|
|
||
| Brackr allows users to find a bike rack near them using Denver city data, navigate to those bike rack by using their current location, while also allowing citizens of Denver to crowd source the locations of new bike racks and comment or report bike rack issues to make commuting and locking up bikes safer and easier. | ||
|
|
||
| ## Installation Instructions | ||
| ## Production | ||
|
|
||
| Brackr is currently hosted on Heroku: https://brackr.herokuapp.com/ | ||
|
|
||
| **Notes:** | ||
| * You must allow Brackr to use your browser's current location. | ||
| * Bike rack locations are currently strictly limited to the city of Denver | ||
| * Locations are seeded courtesy of the [City of Denver's Open Data Catalog](https://www.denvergov.org/opendata/dataset/city-and-county-of-denver-bike-racks) | ||
|
|
||
| ## Tutorial | ||
|
|
||
| On the first page, Brackr will find the 20 nearest bike racks to your current location. | ||
|
|
||
|  | ||
|
|
||
| You can select the pins on the map, or use the "nearest racks" to find a bike rack. | ||
|
|
||
|  | ||
|
|
||
| If you want to find the nearest bike racks to a certain location within Denver, use the search bar to find that location and Brackr will re-access the nearest bike racks to your desired location. | ||
|
|
||
|  | ||
|
|
||
|
|
||
| ## Setup Instructions | ||
|
|
||
| 1. Clone down the branch (or fork and then clone down) | ||
|
|
||
| `git clone https://github.com/lao9/brackr.git` | ||
|
|
||
| 2. Navigate into project root | ||
|
|
||
| `cd brackr` | ||
|
|
||
| 3. Bundle project gems | ||
|
|
||
| `bundle install` | ||
|
|
||
| 4. Setup environment keys | ||
|
|
||
| Obtain a google maps Geocode API key [here](https://developers.google.com/maps/documentation/geocoding/intro) and Map API Key [here](https://developers.google.com/maps/documentation/javascript/earthquakes#placing_basic_markers). There should be a button in the top right corner that says "Get a Key". | ||
|
|
||
| Then, using the [figaro](https://github.com/laserlemon/figaro) gem, run the following command in console: | ||
|
|
||
| `bundle exec figaro install` | ||
|
|
||
| Then, open the config/application.yml file created and add the following, pasting in the keys acquired from google: | ||
|
|
||
| ``` | ||
| GOOGLE_GEOCODE_KEY: [YOUR_KEY_HERE] | ||
| GOOGLE_MAP_KEY: [YOUR_KEY_HERE] | ||
| ``` | ||
|
|
||
| 5. Setup database | ||
|
|
||
| `rake db:setup` | ||
|
|
||
| 6. Run tests | ||
|
|
||
| Check that tests are running by typing `rspec` in the console. | ||
|
|
||
| 7. Run server | ||
|
|
||
| Run `rails s` in the console and then navigate to `http://localhost:3000` in your browser. | ||
|
|
||
|
|
||
| ## Neat Gems | ||
|
|
||
| Used `gem 'geokit'` to calculate the distances between the search location and each bike rack. | ||
| * Used [`gem 'geokit'`](https://github.com/geokit/geokit) to calculate the distances between the search location and each bike rack. | ||
| * Used [`gem 'figaro'`](https://github.com/laserlemon/figaro) to keep environment and key variables private | ||
|
|
||
|
|
||
| ## API Services Used | ||
|
|
||
| Google Maps APIs: | ||
|
|
||
| * Geocoding API: https://developers.google.com/maps/documentation/geocoding/intro | ||
| * [Geocoding API](https://developers.google.com/maps/documentation/geocoding/intro): Finds cross streets for given latitude and longitude. | ||
| * [Maps Javascript API](https://developers.google.com/maps/documentation/javascript/earthquakes#placing_basic_markers): visualized bike rack marker data | ||
| * [Places API](https://developers.google.com/maps/documentation/javascript/examples/places-searchbox): Use google maps search box in Brackr map | ||
|
|
||
| ## API Endpoints | ||
|
|
||
| ### Default Brack Index | ||
|
|
||
| `GET /api/v1/bracks` | ||
|
|
||
| Returns collection of 20 brack objects sorted by distance closest to the default location (Turing School in Denver): | ||
|
|
||
| * Maps Javascript API: https://developers.google.com/maps/documentation/javascript/earthquakes#placing_basic_markers | ||
| ``` | ||
| [ | ||
| { | ||
| "id": 105, | ||
| "lat": 39.7495666290001, | ||
| "long": -105.000145148, | ||
| "cross_streets": "LoDo", | ||
| "owner": "City of Denver", | ||
| "distance": 0.015287669880779668 | ||
| }, | ||
| { | ||
| "id": 104, | ||
| "lat": 39.7498516350001, | ||
| "long": -105.000461602, | ||
| "cross_streets": "15th St & Blake St", | ||
| "owner": "City of Denver", | ||
| "distance": 0.017625856700506287 | ||
| }, | ||
| { | ||
| "id": 106, | ||
| "lat": 39.7497392130001, | ||
| "long": -105.000707391, | ||
| "cross_streets": "1500", | ||
| "owner": "City of Denver", | ||
| "distance": 0.017706108128404854 | ||
| } | ||
| ] | ||
| ## Project Internal API Endpoints | ||
| ``` | ||
|
|
||
| ### Brack Index with LatLng Params | ||
|
|
||
| When a user makes a get request to api/v1/racks, we get a list of all rack objects | ||
| We'd typically expect a parameter of lat and long: | ||
| api/v1/racks?lat=[]&long=[] | ||
| This returns JSON of all racks, sorted by distance from the lat and long params. | ||
| Default limit is 20, but if a limit params is added, then it can be adjusted. | ||
| api/v1/racks?lat=[]&long=[]&limit=15 | ||
| OR | ||
| api/v1/racks?limit=15 | ||
| `GET /api/v1/bracks?latlng=39.750596200000004,-104.9964367` | ||
|
|
||
| Returns collection of 20 brack objects sorted by distance closest to the given location in params: | ||
|
|
||
| ``` | ||
| [ | ||
| { | ||
| "id": 383, | ||
| "lat": 39.7505684980001, | ||
| "long": -104.996696391, | ||
| "cross_streets": "17th St & Market St", | ||
| "owner": "City of Denver", | ||
| "distance": 0.013942751541404737 | ||
| }, | ||
| { | ||
| "id": 59, | ||
| "lat": 39.7503440410001, | ||
| "long": -104.996195264, | ||
| "cross_streets": "LoDo", | ||
| "owner": "City of Denver", | ||
| "distance": 0.02165838893241953 | ||
| }, | ||
| { | ||
| "id": 365, | ||
| "lat": 39.75017166, | ||
| "long": -104.996291989, | ||
| "cross_streets": "17th St & Lawrence St", | ||
| "owner": "City of Denver", | ||
| "distance": 0.03035737996761881 | ||
| } | ||
| ] | ||
| ``` | ||
|
|
||
| ## Upcoming Features | ||
|
|
||
| * Circumvent browsers with geolocation disabled or unavailable | ||
| * Ability for users to add new racks not included in Denver dataset | ||
| * Seed with [Denver B-Cycle Data](https://denver.bcycle.com/pages-in-top-navigation/map) | ||
| * Add Navigation Options | ||
| * Allow users to add comments | ||
| * Allow users to save their favorite bike rack location | ||
|
|
||
| ## Contact Information | ||
|
|
||
| Creator: Lauren Oliveri | ||
| Email: [email protected] | ||
|
|
||