BikeSpace is a community-built web app that lets people report the issues they find when trying to park their bikes in the City of Toronto. For more about the project, please see bikespace.ca.

The BikeSpace application has 2 major components: the backend API, and the frontend (which includes both the submission form and the dashboard). They are split up accordingly into their own directories:

• /bikespace_api (url: api-dev.bikespace.ca)
• /bikespace_frontend (url: bikespace.ca)

To run any of these components please see the README in each directory.

This repository also has a /datasets folder for miscellaneous project data and an /archive folder for code from previous project webpages that are now deprecated.

• When working on a new feature, please always check out a new branch from the latest main branch.
• When submitting Pull Requests, please submit PRs to the development branch from the feature branch you are working off of.
• Squash and merge is preferred for approved pull requests to keep a clean history of project changes.

For more information about contributing to the BikeSpace project, please read the Get Involved section of our website.

Most development tasks in this repository (e.g. running apps, linting code) can be run using make targets that simplify multiple steps into one command and work cross-platform. For example, to run bikespace_frontend locally while developing, you can run the following in a terminal:

$ make dev-frontend

Note that you may need to ensure that there are no spaces in the filepath for the project directory for the make command to work as intended.