This starter kit allows you to quickly get started with creating a client application built on the Shareabouts API.
- In src/config/, copy local_settings.py.template to local_settings.py
- Set your dataset root and api key in the local_settings.py file
- Place your index.html in shareabouts_client/templates/ folder
- Place your static files in the shareabouts_client/static/ folder; refer to the static files folder with the {{ STATIC_URL }} variable
For documentation on using the API see ...
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
Shareabouts is a project of the Civic Works group at OpenPlans.