Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 2.55 KB

README.md

File metadata and controls

37 lines (24 loc) · 2.55 KB
Raw

meep

Mapping Energy Efficiency & Public Health

Image of Beaker

Project Overview

Metropolitan Energy Center (MEC) is a nonprofit promoting energy efficiency, economic development, and environmental vitality in and around Kansas City. As the host of Kansas City's local Clean Cities Coalition, the organization works to assist fleets in converting to alternative fuels. Their projects improve air quality and reduce the use of foreign oil. MEC also takes an active role in reducing energy consumption of residential and commercial buildings by providing training, online tools, and low cost audits.

The aim of this project is to create a central database that consolidates MEC's data on the impact their programs have on air quality and improving public health, and then to create a map-based interface to the data. This app will provide MEC with a means to summarize the impact of their work to their funders. It will also be used to increase the general public's awareness of local projects dedicated to improving sustainabilty.

Technology Stack (Still subject to change)

  • React frontend
  • Flask API
    • Served by gunicorn
  • Database: Postgres
  • Nginx reverse proxy
  • All tied together by Docker

We are looking for developers who have experience with GIS or mapping apis.

How to Contribute

  1. Check out the issues page to see what work currently needs to be done. For a more organized layout, try installing the ZenHub plugin.
  2. Leave a comment under the issue you want to work on. A project owner will then assign it to you.
  3. Clone the repo to your machine. See here for details on how to do this.
  4. Create a branch whose name adheres to the following format: issue_{{issue number}}_{{name of issue}}. For example, if you are working on issue number 4, which is titled "Design database schema", you might name your branch issue_4_database_schema. For more info on working with branches in git, see here.
  5. Do some work on your branch.
  6. Push your branch back to github and open a pull request. See here for details. A project owner will review your changes and either approve a merge, or leave comments on what needs to be done before your changes can be merged.

Installation

Linux/MacOS

Windows