colouring-montreal/README.md

113 lines
8.5 KiB
Markdown
Raw Normal View History

2023-02-09 06:04:37 -05:00
# Colouring Cities Core Platform
2022-02-16 09:19:04 -05:00
[![All Contributors](https://img.shields.io/badge/all_contributors-12-orange.svg?style=flat-square)](#contributors)
![Build status](https://github.com/colouring-london/colouring-london/workflows/Node.js%20CI/badge.svg)
2018-04-11 17:54:30 -04:00
2023-02-09 06:04:37 -05:00
How many buildings are there in a city? What are their characteristics? Where
2018-04-11 17:54:30 -04:00
are they located and how do they contribute to the city? How adaptable are
they? How long will they last, and what are the environmental and
socio-economic implications of demolition?
2023-02-09 06:04:37 -05:00
Colouring Cities is a web-based citizen social
2018-04-11 17:54:30 -04:00
science project designed to help address these questions by crowdsourcing and
visualising twelve categories of information on Londons buildings.
## Structure
This repository will contain open-source code for the project which:
2018-04-11 17:54:30 -04:00
- stores building footprint polygons and source metadata
- allows site users to record building attribute data
- serves map tiles rendered from collected data
- allows site visitors to download the collected building attribute data
Building attribute data collected as part of the project will be made available
2018-09-10 07:41:08 -04:00
for download under a liberal open data license
([ODbL](https://opendatacommons.org/licenses/odbl/1.0/)).
2018-04-11 17:54:30 -04:00
2018-08-01 09:31:34 -04:00
## Setup and run
2022-02-24 06:20:14 -05:00
#### Test the application:
2022-02-24 06:17:31 -05:00
2022-02-24 06:20:14 -05:00
You can try out the Colouring London application by setting up your own development environment, which includes the option to load test data from OpenStreetMaps (OSM). See [docs/setup-dev-environment](docs/setup-dev-environment.md).
2022-02-24 06:17:31 -05:00
_Last updated March 2022_
2022-02-24 06:17:31 -05:00
2022-02-24 06:20:14 -05:00
#### Create a production version of the application:
We also have documentation on setting up a production environment here: [docs/setup-production-environment](docs/setup-production-environment.md).
2022-02-24 06:17:31 -05:00
_Last updated December 2021_
2022-02-24 06:20:14 -05:00
**Note:** There are additional useful documentation within the `/docs` folder.
2018-09-10 05:48:34 -04:00
## Acknowledgements
2018-04-11 17:54:30 -04:00
Colouring London was set up at the Centre for Advanced Spatial
Analysis (CASA), University College London and is now based at The Alan Turing Institute.
2018-04-11 17:54:30 -04:00
Ordnance Survey is providing building footprints required to collect the data,
2018-11-21 17:52:22 -05:00
facilitated by the Greater London Authority (GLA), and giving access to its API
and technical support.
2018-12-03 06:08:20 -05:00
## License
Colouring London
2022-01-14 05:54:44 -05:00
Copyright (C) 2018-2022 Tom Russell and Colouring London contributors
2018-12-03 06:08:20 -05:00
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
2019-02-23 09:32:15 -05:00
## Contributors
<!-- this section is updated using external bot, see https://allcontributors.org/docs/en/bot/usage - post comment like
@all-contributors please add @<username> for <contributions>
to trigger it, for example
@all-contributors please add @<username> for code
@all-contributors please add @<username> for code and docs
-->
2019-02-23 09:32:15 -05:00
Thanks goes to these wonderful people ([emoji key](https://github.com/all-contributors/all-contributors#emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
2022-01-17 05:46:03 -05:00
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
2019-10-02 16:55:56 -04:00
<table>
2022-09-26 10:41:23 -04:00
<tbody>
<tr>
<td align="center"><a href="https://github.com/polly64"><img src="https://avatars3.githubusercontent.com/u/42236514?v=4?s=100" width="100px;" alt=""/><br /><sub><b>polly64</b></sub></a><br /><a href="#design-polly64" title="Design">🎨</a> <a href="#ideas-polly64" title="Ideas, Planning, & Feedback">🤔</a> <a href="#content-polly64" title="Content">🖋</a> <a href="#fundingFinding-polly64" title="Funding Finding">🔍</a></td>
<td align="center"><a href="https://github.com/tomalrussell"><img src="https://avatars2.githubusercontent.com/u/2762769?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Tom Russell</b></sub></a><br /><a href="#design-tomalrussell" title="Design">🎨</a> <a href="#ideas-tomalrussell" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/colouring-cities/colouring-london/commits?author=tomalrussell" title="Code">💻</a> <a href="https://github.com/colouring-cities/colouring-london/commits?author=tomalrussell" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/mz8i"><img src="https://avatars2.githubusercontent.com/u/36160844?v=4?s=100" width="100px;" alt=""/><br /><sub><b>mz8i</b></sub></a><br /><a href="https://github.com/colouring-cities/colouring-london/commits?author=mz8i" title="Code">💻</a> <a href="#ideas-mz8i" title="Ideas, Planning, & Feedback">🤔</a></td>
<td align="center"><a href="https://dghumphrey.co.uk/"><img src="https://avatars0.githubusercontent.com/u/6041913?v=4?s=100" width="100px;" alt=""/><br /><sub><b>dominic</b></sub></a><br /><a href="#ideas-dominijk" title="Ideas, Planning, & Feedback">🤔</a> <a href="#content-dominijk" title="Content">🖋</a></td>
<td align="center"><a href="https://github.com/adamdennett"><img src="https://avatars1.githubusercontent.com/u/5138911?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Adam Dennett</b></sub></a><br /><a href="#ideas-adamdennett" title="Ideas, Planning, & Feedback">🤔</a></td>
<td align="center"><a href="https://github.com/duncan2001"><img src="https://avatars1.githubusercontent.com/u/19817528?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Duncan Smith</b></sub></a><br /><a href="#ideas-duncan2001" title="Ideas, Planning, & Feedback">🤔</a></td>
<td align="center"><a href="https://github.com/martin-dj"><img src="https://avatars2.githubusercontent.com/u/7262550?v=4?s=100" width="100px;" alt=""/><br /><sub><b>martin-dj</b></sub></a><br /><a href="https://github.com/colouring-cities/colouring-london/commits?author=martin-dj" title="Code">💻</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/MeldaS"><img src="https://avatars2.githubusercontent.com/u/33935846?v=4?s=100" width="100px;" alt=""/><br /><sub><b>MeldaS</b></sub></a><br /><a href="https://github.com/colouring-cities/colouring-london/commits?author=MeldaS" title="Code">💻</a></td>
<td align="center"><a href="#"><img src="docs/images/green.png?s=100" width="100px;" alt=""/><br /><sub><b>Tarn Hamilton</b></sub></a><br /><a href="#design" title="Design">🎨</a></td>
<td align="center"><a href="http://www.louisjobst.com/index.php/about/"><img src="docs/images/yellow.png?s=100" width="100px;" alt=""/><br /><sub><b>Louis Jobst</b></sub></a><br /><a href="#design" title="Design">🎨</a></td>
<td align="center"><a href="http://edchalstrey.com/"><img src="https://avatars.githubusercontent.com/u/5486164?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ed Chalstrey</b></sub></a><br /><a href="https://github.com/colouring-cities/colouring-london/commits?author=edwardchalstrey1" title="Code">💻</a> <a href="https://github.com/colouring-cities/colouring-london/commits?author=edwardchalstrey1" title="Documentation">📖</a></td>
<td align="center"><a href="https://mapsaregreat.com/"><img src="https://avatars.githubusercontent.com/u/899988?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Mateusz Konieczny</b></sub></a><br /><a href="https://github.com/colouring-cities/colouring-london/commits?author=matkoniecz" title="Code">💻</a> <a href="https://github.com/colouring-cities/colouring-london/commits?author=matkoniecz" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/mdsimpson42"><img src="https://avatars.githubusercontent.com/u/21125422?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Mike Simpson</b></sub></a><br /><a href="https://github.com/colouring-cities/colouring-london/commits?author=mdsimpson42" title="Code">💻</a> <a href="https://github.com/colouring-cities/colouring-london/commits?author=mdsimpson42" title="Documentation">📖</a></td>
</tr>
</tbody>
2019-10-02 16:55:56 -04:00
</table>
2019-03-22 05:12:59 -04:00
2022-01-17 05:46:03 -05:00
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
2019-02-23 09:32:15 -05:00
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
Even more thanks go to Colouring London contributors, funders, project partners, consultees,
advisers, supporters and friends - [everyone involved in the
project](https://www.pages.colouring.london/whoisinvolved).