https://github.com/openplans/shareabouts-pbcambridge
Collaborative map for the Cambridge MA participatory budgeting process
https://github.com/openplans/shareabouts-pbcambridge
Last synced: 3 months ago
JSON representation
Collaborative map for the Cambridge MA participatory budgeting process
- Host: GitHub
- URL: https://github.com/openplans/shareabouts-pbcambridge
- Owner: openplans
- License: gpl-3.0
- Created: 2014-11-26T15:57:54.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-08-07T20:59:49.000Z (almost 11 years ago)
- Last Synced: 2024-04-15T14:26:44.619Z (about 2 years ago)
- Language: JavaScript
- Homepage:
- Size: 6.55 MB
- Stars: 1
- Watchers: 7
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Shareabouts [](http://travis-ci.org/openplans/shareabouts) [](http://dploy.io)
===========
Shareabouts is an online mapping tool to gather crowdsourced public input in a social and engaging process. Using Shareabouts, people can drop a pin on a map to provide ideas, suggestions, and comments for planning and design issues. And as a mobile-friendly application, Shareabouts makes it easy to add input on the go.
Read more about Shareabouts and find links to recent sites [on the OpenPlans website](http://openplans.org/shareabouts/).
A short guide to setting up Shareabouts
-----------
It's helpful, but not required, to know about the [architecture of Shareabouts](https://github.com/openplans/shareabouts/blob/master/doc/ARCHITECTURE.md) before starting.
The easiest way to set up Shareabouts is to use the Heroku Button.
[](https://heroku.com/deploy)
This will deploy a fully-functional Shareabouts map and datastore to your account on Heroku (an easy-to-manage hosting service). Hosting this way will cost $50-100 monthly. [Here's the process](https://github.com/openplans/shareabouts/blob/master/doc/HEROKU_BUTTON.md).
Alternatively, you may want to use a [different hosting service](https://github.com/openplans/shareabouts/blob/master/doc/DEPLOY.md) and set up the components of Shareabouts manually.
Documentation
-------------
All of our documentation is is our `doc` directory. Use it to learn more about:
* [the architecture](https://github.com/openplans/shareabouts/blob/master/doc/ARCHITECTURE.md)
* [local setup](https://github.com/openplans/shareabouts/blob/master/doc/README.md)
* [testing the source](https://github.com/openplans/shareabouts/blob/master/doc/TESTING.md)
* [interface configuration](https://github.com/openplans/shareabouts/blob/master/doc/CONFIG.md)
* [custom themes](https://github.com/openplans/shareabouts/blob/master/doc/CUSTOM_THEME.md)
* [deploying with the Heroku button](https://github.com/openplans/shareabouts/blob/master/doc/HEROKU_BUTTON.md) and [in other ways](https://github.com/openplans/shareabouts/blob/master/doc/DEPLOY.md)
* [upgrading from an older version](https://github.com/openplans/shareabouts/blob/master/doc/UPGRADE.md)
* [getting your data once you have a map running](https://github.com/openplans/shareabouts/blob/master/doc/GETTING_YOUR_DATA.md)
Questions? Problems? Ideas?
--------------------
The best place to ask questions or get help is [community.openplans.org](http://community.openplans.org), an open forum on Shareabouts (and some other stuff from OpenPlans). Asking questions there will help everyone else.
If you encounted a bug, [create an issue](https://github.com/openplans/shareabouts/issues) on this GitHub repo.
We have a [Trello board](https://trello.com/b/94MT3WRQ/openplans-roadmap) to collect feature suggestions, but you might get more eyeballs and responses by posting to the forum first.
Contributing
------------
In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
Here are some ways *you* can contribute:
* by joining our developers discussion list: http://groups.google.com/group/shareabouts-dev
* by taking a look at our pipeline in the public tracker: https://www.pivotaltracker.com/projects/398973
* by using alpha, beta, and prerelease versions
* by reporting bugs
* by suggesting new features
* by writing or editing documentation
* by writing specifications
* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
* by refactoring code
* by resolving issues
* by reviewing patches
Credits
-------------
Shareabouts is a project of [OpenPlans](http://openplans.org).