streetmix/streetmix

<p align="center">
  <a href="http://streetmix.net/">
    <img width="450" alt="Streetmix" src="https://user-images.githubusercontent.com/2553268/62242301-dc18c800-b3a8-11e9-9960-6f6cbac50234.png">
  </a>
</p>

<p align="center">
  <b>Streetmix is a collaborative process for communities and city planners to improve public spaces.</b> 
  <br>Design, remix, and share your neighborhood street at <a href="https://streetmix.net/">streetmix.net</a>.
</p>

<p align="center">
  :couple: :palm_tree: :oncoming_automobile: :oncoming_bus: :palm_tree: :dancer:
</p>

<p align="center">
  <br><b><a href="https://strt.mx/discord">Join our community on Discord!</a></b>
</p>

<p align="center">
  <b>We welcome contributions!</b>
  <br>Please see our <a href="https://docs.streetmix.net/contributing/intro">contributor guidelines</a>.
</p>

<p align="center">
  <a href="https://github.com/streetmix/streetmix/actions/workflows/ci.yml"><img alt="Build status" src="https://img.shields.io/github/actions/workflow/status/streetmix/streetmix/ci.yml?branch=main&style=for-the-badge"></a>
  <a href="https://codecov.io/gh/streetmix/streetmix"><img alt="Code coverage" src="https://img.shields.io/codecov/c/gh/streetmix/streetmix.svg?label=test%20coverage&style=for-the-badge"></a>
</p>

<hr>

<p align="center">
  <img src="https://github.com/streetmix/streetmix/raw/main/docs/static/screenshot.png" alt="screenshot">
</p>

## About

#### What are street sections?

A "section" is shortened way of saying "cross-section view", a type of 2D non-perspectival drawing commonly used in engineering and architecture to show what something looks like when you take a slice of it and look at it head-on. Similarly, a street section is a cross section view of a street, showing the widths and placement of vehicle lanes, bike lanes, sidewalks, trees, street furniture or accessories (like benches or street lamps), as well as engineering information like how the road is sloped to facilitate drainage, or the locations of underground utilities. Although sections can be simplified line drawings, urban designers and landscape architects have created very colorful illustrative street sections, removing most of the engineering particulars to communicate how a street could be designed to feel safe, walkable or habitable.

![example-sections](docs/static/thumb_sections.png "Left to Right: (1) Existing conditions section of Market Street, from the Better Market Street Plan, San Francisco (2) Proposed one-way cycletrack design of Second Street, from the Great Second Street Plan, San Francisco (3)Example of an illustrative section, courtesy of Lou Huang")

#### Why does Streetmix exist?

When city planners seek input from community meetings from the public on streetscape improvements, one common engagement activity is to create paper cut-outs depicting different street components (like bike lanes, sidewalks, trees, and so on) and allow attendees to reassemble them into their desired streetscape. Planners and city officials can then take this feedback to determine a course of action for future plans. By creating an web-based version of this activity, planners can reach a wider audience than they could at meetings alone, and allow community members to share and remix each other's creations.

The goal is to promote two-way communication between planners and the public, as well. Streetmix intends to communicate not just feedback to planners but also information and consequences of actions to the users that are creating streets. Kind of like SimCity did with its in-game advisors!

Streetmix can be used as a tool to promote and engage citizens around streetscape and placemaking issues, such as [Complete Streets][completestreets] or the Project for Public Spaces' [Rightsizing Streets Guide][rightsizing].

[completestreets]: https://smartgrowthamerica.org/program/national-complete-streets-coalition/
[rightsizing]: http://www.pps.org/reference/rightsizing/

#### Why the name "Streetmix"?

"Streets" + "remix" :-)

#### How did this project start?

Streetmix started as a [Code for America][cfa] hackathon project in January 2013, inspired by community meetings like the one described above.

[cfa]: https://codeforamerica.org/

#### How do I install / set up Streetmix myself?

Streetmix is a [Node.js](https://nodejs.org/) based project. Set up your own by [following these instructions](https://docs.streetmix.net/contributing/code/local-setup)!

## Sponsors

<p align="center">
  <a href="https://opencollective.com/streetmix"><img src="https://opencollective.com/streetmix/sponsors.svg" alt="Become a sponsor"></a>
</p>

## Copyright

Copyright (c) 2013-2018 Code for America and contributors.  
Copyright (c) 2019-2024 Streetmix LLC.  
See [LICENSE][] for details.

[license]: https://github.com/streetmix/streetmix/blob/main/LICENSE

Streetmix is maintained by [Bad Idea Factory](https://biffud.com/) with the support of many contributors.