Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 3.47 KB

README.md

File metadata and controls

59 lines (43 loc) · 3.47 KB

Shareabouts Build Status

Join the chat at https://gitter.im/openplans/shareabouts

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.

A short guide to setting up Shareabouts

It's helpful, but not required, to know about the architecture of Shareabouts before starting.

The easiest way to set up Shareabouts is to use the Heroku Button.

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.

Alternatively, you may want to use a different hosting service and set up the components of Shareabouts manually.

Documentation

All of our documentation is is our doc directory. Use it to learn more about:

Questions? Problems? Ideas?

If you encounter a bug, create an issue on this GitHub repo.

Contributing

In the spirit of free software, 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.