A simple, free, and open-source web app that helps get a random scenic drive near you.
We welcome contributions from the community! Follow the steps below to set up the project locally and start contributing.
-
Clone the repository:
git clone https://github.com/harryt04/route-roulette.git route-roulette cd route-roulette
-
Create your feature branch:
git checkout -b feature/your-feature-name
-
Install dependencies:
npm install
-
Configure environment variables:
- Rename
.env-sample
to.env
or copy it:cp .env-sample .env
- Supply your own Google Maps API key in the
.env
file to use for api calls when running locally.
- Rename
-
Run the app:
npm run dev
-
Submit a pull request targeting
master
:- Ensure your branch is up to date with the latest changes from
master
. - Push your feature branch to the repository.
- Open a pull request on GitHub targeting the
master
branch.
- Ensure your branch is up to date with the latest changes from
-
Required build check for PRs:
npm run build
Thank you for contributing to Route Roulette! Your help is greatly appreciated.