Check out our live application page at: ride-tandem.ca
Watch the demonstation video here
Contact us with a bug or suggestion by making an issue.
Checkout who built this application on our wiki
Try to make an issue before trying to fix it, you may find someone is already on it!
Barring that, make a pull request with your changes - we prefer, although do not enforce, a linear git history.
Someone should come along and review your code, if it looks good your changes should be live as soon as they are merged!
All that is needed to run it is node. Make sure to add it is on your PATH.
Of course downloading node off thier site and using their installer is an option. But I recommend using
Windows - chocolatey
MacOS - brew
Linux - whatever package manager your distro comes with
Run node --version in a terminal. The output should look something like
[marcus@fedora ~]$ node --version
v16.13.2
This app relies on the MapQuest API for some features, in order to use them acquire a key from here
and create an .env file in frontend with REACT_APP_MQ_KEY=<YOUR KEY>.
While in the frontend directory run npm install to install dependancies.
This application uses Firebase services that need to be emulated locally. Run npm run emulators to start the emulators. You can view the firebase console at localhost:3001.
To start developing run npm start. This should open your default browser to the application. Change a file and save it and the application should reload.
This project is tested using Cypress. The tests can be run locally by linking to the Firebase emulators.
To begin, create a new service account in the firebase console. Add the path to your serviceAccount.json file into your GOOGLE_APPLICATION_CREDENTIALS environment variable.
You will also need the UID of a testing user to authenticate your tests. Create a cypress.env.json file and add the UID of your user to the TEST_UID json key.
First run npm run emulators:CI to run the emulators using the testing data in cypress-emulator-data.
Next run npm start to start the application.
Finally run npm run cypress to start cypress and select the spec files you want to test.
We're GPL-3.0 licensed, if you don't like the license in its full glory, this is a nice synopsis.