/trashradar-api

The api to let your public servants and community know where there is cleaning to be done.

Primary LanguagePython

Trashradar-api

The api to let your public servants and community know where there is cleaning to be done.

Problem

Some public places are used as garbage storage and authorities wait too long to clean them

Solution

Web/mobile application that help public servants and community to pinpoint trash places and direct authorities to these

Features

  • Save locations
  • Upload pictures and link them to locations
  • Send tweets to authorities

First phase

  • Build trashradar-api
  • Create a simple web front-end application that help us to test and develop the API

Second phase

  • Build mobile application as API client for trashradar-api

Development

Development on TrashRadar API should be done locally.

Code Style

We use PEP8 with 119 as max line length.

    pep8 --max-line-length=119

For workflow we use forks, feature branches, and pull requests from forks.

Workflow

  1. Fork the team repository
  2. Clone [your fork](https://github.com/{{your github username}}/trashradar-api)
  3. Select or create an issue in the Issue Queue
  4. Create a branch for the issue prepended with the issue number and a short description using _ in place of spaces.
  5. Commit changes to the branch.
  6. Push branch to your fork.
  7. When ready for review, submit pull request, begin the pull request with the issue number.