Skip to content

Latest commit

 

History

History
64 lines (53 loc) · 3.33 KB

README.md

File metadata and controls

64 lines (53 loc) · 3.33 KB
Raw

Bikerentalmap

Demo: brm-react-demo.bikerentalmap.com

React based App showing availables bikes, scooters etc. Data are provided by the flucto API

Install and run

You should have a current version (9+) of NodeJs installed on your machine.

  1. Clone or download this repo.
  2. In order to use the HERE Geocoder API, create an account for free.
  3. To fetch vehicle data create a developer account for the flucto API (it's free for hoby prject and low traffic applications)
  4. Create an .env File and add the necessary API tokens: 
    REACT_APP_HERE_APP_ID=YOUR_APP_ID
REACT_APP_HERE_APP_CODE=YOUR_APP_CODE
REACT_APP_MULTICYCLES_API_TOKEN=YOUR_API_TOKEN
  5. Install the packages via yarn or npm install
  6. Start the development server with yarn start or npm run start

Services, Sources and Inspirations

  • the Address Autocomplete Form use the GGeocoder API from HERE
  • The Vehicles Data use the API provided by Fluctuo (former Multicycles). Thanks to the work of Pierrick Paul!

Some words about the Code

3rd part libraries

I mostly try to avoid add additional libraries in order to have more knowledge and confidence of my code and keep the payload small. Nevertheless I start with some few wellknown packages which may simplify or speed up development and replace some of them later with leaner solutions.

Services and packages used:

  • FetchAPI vs. Axios: opting here for the native FetchAPI because it's lean (Downside: missing IE11 support)-> might change
  • react-autosuggest: speed up development and ensure accessibilty
  • react-apollo, apollo-boost etc: the most convinient way to handle grapqhql queries
  • Leaflet-Maps: I prefer Open Source Solutions over propiertary ones (e.g.) Google Maps; especially to avoid subitting user data to third parties
  • HERE geolocation: try out an alternative to Google GeolocationAPI, works pretty good so far

Styling

In general I prefer good old css styles in separate files. Css-in-js tends to blow up a component and ends up in writing duplicate code. So I started with simple css, planing to integrate some pre/postprocessing. Anyhow I will give styled-components a try, just to learn and see if or when it make sense to use it.

Testing

I don't have much experience in testing yet and I always wondered how do I know what tests are useful. After some reading I decided to concentrate on Integration tests, ignore snapshot tests(except they make sense); some unit tests and later some E2E Test w/ Cypress (yet to come); Just started.

Todo

  • add submitbutton to locationsearchform
  • add skip to main (a11y)
  • improve vehicle details layout;
  • refetch with debounce on moveend
  • show more details (scooter, battery, station)
  • change mapprovider
  • cache policy (prevent refetching on page switch)
  • testing with jest and react-testing
  • TravisCI
  • fitbound map to results
  • add filter options (for provider and vehicle types)
  • enable PWA
  • convert into Monorepo with own Graphql endpoint for usage of further API (bikeciti.es et. al.)