Merge pull request #132 from sproutverse/feat/add-more-documentation

Document data sources and Yarn scripts in README

README.md

@@ -1,6 +1,29 @@
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+# Gatesolve
 
-## Available Scripts
+Gatesolve provides directions for door-to-door deliveries.
+Whether you are driving a truck full of soda or delivering a meal,
+we can help you find the correct entrance and the way there.
+
+## Data sources
+
+* Route calculations are done based on data from OpenStreetMap with the Planner.js library.
+The OpenStreetMap data is loaded in the Routable Tiles format as provided by Forum Virium Helsinki
+at https://tile.olmap.org/routable-tiles/
+
+* Building entrance data is from OpenStreetMap and the OSM QA tiles as provided at https://tile.olmap.org/osm-qa-tiles/
+
+* Address and POI search is based on OpenStreetMap and other data as provided by Digitransit's Pelias endpoint.
+
+* Background map is based on OpenStreetMap as provided by Digitransit and the HSL map style.
+
+## Getting started
+
+```
+yarn
+yarn start
+```
+
+## Available commands
 
 In the project directory, you can run:
 
@@ -17,6 +40,24 @@ You will also see any lint errors in the console.
 Launches the test runner in the interactive watch mode.<br />
 See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
 
+### `yarn test-e2e`
+
+Launches the test runner for end-to-end tests.
+By default, the tests are run against [http://localhost:3000](http://localhost:3000),
+so you should run `yarn start` in parallel.
+Alternatively, you can set the environment variable `E2E_TEST_URL`, e.g.
+```
+E2E_TEST_URL=https://app.gatesolve.com yarn test-e2e
+```
+
+### `yarn prettier`
+
+Formats the source code using Prettier's default settings.
+
+### `yarn eslint`
+
+Lints the source code using ESLint and our config at `.eslintrc.js`.
+
 ### `yarn build`
 
 Builds the app for production to the `build` folder.<br />
@@ -27,17 +68,9 @@ Your app is ready to be deployed!
 
 See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
 
-### `yarn eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+## Create React App
 
-## Learn More
+This project uses [Create React App](https://github.com/facebook/create-react-app).
 
 You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).