Skip to content

Latest commit

 

History

History
103 lines (77 loc) · 3.76 KB

README.md

File metadata and controls

103 lines (77 loc) · 3.76 KB
Raw

Stray Pet Mapper Build Status

Reunite more stray animals with their human companions

Screenshot

City Petz: Stray Mapper

Demo

You can see a running version of the application at http://stray.citypetz.com/.

Development Environment

Ubuntu Environment

Instructions for creating a development environment for Ubuntu Linux. This has been tested using Ubuntu 12.04.

#Initial libraries needed
$ sudo apt-get install build-essential git-core python-software-properties python-dev python-pip python-virtualenv

#PIL Dependencies
$ sudo apt-get install build-dep python-imaging

Also symlink associated libraries:
$ sudo ln -s /usr/lib/`uname -i`-linux-gnu/libfreetype.so /usr/lib/
$ sudo ln -s /usr/lib/`uname -i`-linux-gnu/libjpeg.so /usr/lib/
$ sudo ln -s /usr/lib/`uname -i`-linux-gnu/libz.so /usr/lib/

# Install PostgreSQL/Postgis
$ sudo apt-get install postgresql-9.1
$ sudo apt-get install postgresql-9.1-postgis

Mac Environment

This project uses PostgreSQL/Postgis and the best way to get this setup on the mac is by downloading Postgres.app

Installation

git clone git://github.com/codeforamerica/straymapper.git
cd straymapper
pip install -r requirements.txt
./manage.py syncdb

Usage

./manage.py runserver

Seed Data

./manage.py loaddata animals/fixtures/animals_testdata.json

Contributing

In the spirit of free software, everyone is encouraged to help improve this project.

Here are some ways you can contribute:

  • by using alpha, beta, and prerelease versions
  • by reporting bugs
  • by suggesting new features
  • by translating to a new language
  • 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 closing issues
  • by reviewing patches
  • financially

Submitting an Issue

We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. You can indicate support for an existing issue by voting it up. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.

Submitting a Pull Request

  1. Fork the project.
  2. Create a topic branch.
  3. Implement your feature or bug fix.
  4. Add tests for your feature or bug fix.
  5. Run ./manage.py test. If your changes are not 100% covered, go back to step 4.
  6. Commit and push your changes.
  7. Submit a pull request. Please do not include changes to the gemspec or version file. (If you want to create your own version for some reason, please do so in a separate commit.)

Copyright

Copyright (c) 2012 Code for America. See LICENSE for details.