Skip to content

Latest commit

 

History

History
86 lines (53 loc) · 2.98 KB

README.md

File metadata and controls

86 lines (53 loc) · 2.98 KB
Raw

Gatesolve

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

Forking

GitHub Actions require a few secrets:

  • NETLIFY_SITE_ID: The draft and production builds are deployed to Netlify. This variable identifies the site at Netlify.
  • NETLIFY_AUTH_TOKEN: The token for deploying to Netlify.
  • PRODUCTION_URL: The reference URL to compare with the draft URL in the Lighthouse performance testing of the pull request. This is only a secret because public environment variables would have to go into the CI/CD YAML file. Adding the URL there would hinder forking.

Available commands

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about 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, 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.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Create React App

This project uses Create React App.

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.