• Help
• Journey Planner
• How it works
• OSM
• Developers
• API
• Photomap
• Photo licensing

Developers

Welcome to the Developer section of CycleStreets. We are keen to welcome new developers and code contributions from the community.

We welcome any feedback you can provide on this section.

API access

If you just need programmatic access to our routing (rather than want to get involved in coding of CycleStreets itself), please see the API documentation.

Overview of CycleStreets

All developers should firstly familiarise themselves with the Overview of CycleStreets.

Software required

The server-side code is written in object-orientated PHP, but we hope that people familiar with other languages shouldn’t find it too difficult to understand what’s there.

• Any OS (Windows/Mac/Linux are all known to work fine – we like to code cross-platform!)
• Apache webserver (we use Apache 2.4.x; older should probably work)
• PHP 7.1.x as mod_php in Apache (i.e. not a CGI installation)
• PDO-MySQL (part of PHP, but sometimes bundled as a separate package)
• MySQL 8.x (older almost certainly will not work)
• Git client
• A local installation of PhpMyAdmin or similar to interrogate the database will be useful
• Your favourite text editor :)

Developer agreement

CycleStreets is not yet open source, but is our firm intention to do so in the coming 6-12 months.

We ask developers to sign the Developer Agreement before committing code or (at this stage) being given access to it.

Git access

Please let us know your Github username and we will add access.

Once we have added you, please sign out then sign in again, and this page will have additional links and material.