Skip to content

nickdotreid/platform

 
 

Repository files navigation

Hey Duwamish! Build Status

For a brief summary, please view: http://smartercleanup.org/

We are building a geography based community monitoring platform. Our goal is to empower residents to monitor environmental health issues and engage with local leaders to address their concerns. Our first release is focused on the Lower Duwamish River superfund site in Seattle, WA.

We were inspired by the GarageLab collective in Buenos Aires, Argentina who built Que Pasa Riachuelo to monitor the pollution along the Riachuelo river basin.

More details on getting involved with Hey Duwamish! can be found here

Features

Submit a Report
Adding reports is easy. The simple interface lets users quickly drop pins on the map with descriptions and other useful information.
Comment on Reports
Engage your audience in meaningful conversation. Users can leave [rich media] comments on reports.
Explore Rich Environmental Data
Overlay pertinent geographic data. Applying custom vector data to our Geoserver, the Hey Duwamish! map can pull in GeoJson and WMS URLs as additional map layers.
Mapbox Projeplct Integration
Import a Mapbox project to enhance project management into the map
Explore Reports and Comments
The map allows users to find reports and comments in their areas of interest.
Show Support
Need to know which reports are most popular? Users can vote for their favorite reports to show their support.
Social Sharing
Harness the power of viral marketing. Users engage their social network when they share reports on Twitter and Facebook.
Activity Feed
See a list of recently submitted reports, comments, and support.
Responsive Design
We've designed Hey Duwamish to work great and look beautiful on all screen sizes—desktop, mobile, and touch screens!

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

Internationalization
We currently offer a Spanish version of our website, but we are looking to include a Vietnamese version soon

Contributing

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

Here are some ways you can contribute:

  • 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

Catch us on Freenode at #Smartercleanup

Local Setup

Hey Duwamish! requires Python 2.6 or greater (Instructions for Windows found here).

Install pip and virtualenv, if not already installed. These will keep your python code isolated from the rest of your machine and ensure you have the correct versions.

easy_install pip
pip install virtualenv

You may need to use sudoto install these tools.

sudo easy_install pip
sudo pip install virtualenv

Create a new virtual environment inside of the repository folder, and install the project requirements:

virtualenv env
source env/bin/activate
pip install -r app-requirements.txt

NOTE: If you run into trouble with gevent, you can safely comment it out of the requirements.txt file. It is not needed for local development. To comment it out, just add a hash "#" to the beginning of the line for gevent.

NOTE: If you have trouble with pip install -r app-requirements.txt, you may need to install the Python development libraries (for Python.h). The Windows installation has them by default, but some UNIX-based systems with a pre-installed Python may not. On such systems, you may need to run sudo apt-get install python-dev or download a fresh installer from python.org.

NOTE: For Linux users on RHEL/CentOS distros, you will need to have the following libraries installed: sudo yum groupinstall 'Development Tools' and sudo yum install python-devel postgresql-devel

NOTE: Mac OS X users need a command line C/C++ compiler in place for the above steps to work. This can be done by downloading Xcode from the App Store and then installing the Command Line Tools via Xcode's Preferences > Downloads area.

Configuring the Dev API

We have a Dev API with dummy data that you can load locally. To enable it, go to the src folder and create a new hidden text file called .env and paste in the following information:

FLAVOR=duwamish_flavor
SITE_URL=http://dev-api.heyduwamish.org/api/v2/smartercleanup/datasets/duwamish/
SITE_KEY=MGMzOWU2ZmUwZmFkZDYzZTI1ZmQ3MDhi

Now you're ready to run your server locally. Just enter this command:

src/manage.py runserver

The server will, by default, be started at http://localhost:8000/. It is already configured for Hey Duwamish! but here is the documentation if you want to reconfigure it.

NOTE: If you're new to programming with virtualenv, be sure to remember to activate your virtual environment every time you start a new terminal session:

source env/bin/activate

Credits

Many features are powered by Shareabouts, an open-source project of OpenPlans.

Read more about Shareabouts and find links to recent sites on the OpenPlans website.

About

Hey Duwamish! is a community engagement tool designed for environmental cleanup projects

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 69.1%
  • HTML 14.4%
  • CSS 10.2%
  • Python 5.5%
  • Other 0.8%