The api to let your public servants and community know where there is cleaning to be done.
Some public places are used as garbage storage and authorities wait too long to clean them
Web/mobile application that help public servants and community to pinpoint trash places and direct authorities to these
- Save locations
- Upload pictures and link them to locations
- Send tweets to authorities
- Build trashradar-api
- Create a simple web front-end application that help us to test and develop the API
- Build mobile application as API client for trashradar-api
Development on TrashRadar API should be done locally.
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.
- Fork the team repository
- Clone [your fork](https://github.com/{{your github username}}/trashradar-api)
- Select or create an issue in the Issue Queue
- Create a branch for the issue prepended with the issue number and a short description using _ in place of spaces.
- Commit changes to the branch.
- Push branch to your fork.
- When ready for review, submit pull request, begin the pull request with the issue number.
docker-compose up will launch the configuration in docker-compose.yml, which provides redis and postgres allowing you
to run django on your localhost. Use this when working on the backend.
You should generally use up and stop for day to day development. This is the least overhead approach to starting and
stopping the environment.
The data volume for postgres is persistent. You will need to remove the volume use docker volume rm if you want to
initiate a completely new database.
Run python manage.py loaddata trashradar/fixtures/test_data.json.
The password for all seed users is trashradar.
-
super users have full access to all features of django.
-
TODO: document what staff access means.
-
a verified user.
-
a verified user.