Skip to content

brendannee/bikesy

Repository files navigation

Bikesy

This is a web app for finding bike directions. It is available at http://bikesy.com.

It uses routes based on open street maps and served from the Bikesy Server.

It allows users to specify a start and end point to a route along with a hill tolerance (from avoiding hills to not weighting hills much at all). It allows users to choose between three different scenarios of bike facilities from mainly bike lanes and bike routes to a very direct route.

Routes are displayed using the mapbox API.

Bikesy API

You can pull info directly from the bikesy backend using the Bikesy API.

The assumptions that go into the routes provided by the Bikesy API are documented on the Bikesy API page .

Setup

Create a .env file by copying .env.example.

cp .env.example .env

Add values to your .env config file for all fields. Choose a region, currently sf for San Francisco or tahoe for Lake Tahoe. Or, make your own file in the src/appConfig folder to support a new region and specify that as NEXT_PUBLIC_REGION in your .env file.

Install dependencies:

yarn install

Running Locally

To run locally:

yarn dev

Then open http://localhost:3000 in your browser.

Compiling to static files

yarn export

Files will be in the /out folder

Lints

yarn lint
yarn prettier

About

A front end for displaying routes from bikesy.com

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published