tonykioko / neighborhood

Know your neighbors and stayed informed about everything happening in your neighborhood

Neighborhood Watch

Description

Neighborhood Watch is a web application that allows users to be in the loop about everything happening in their neighborhood. From contact information of different handyman to meeting announcements or even alerts.

---

User Requirements

1. Sign in to the application to start using.
2. Set up a profile about me and a general location and my neighborhood name.
3. Find a list of different businesses in my neighborhood.
4. Find Contact Information for the health department and Police authorities near my neighborhood.
5. Create Posts that will be visible to everyone in my neighborhood
6. Change My neighborhood when I decide to move out.
7. Only view details of a single neighborhood.

Live Link

NeighborHood Watch

Getting started

Requirements

This project was created on a debian linux platform but should work on other unix based[not limited to] sytems.

• Tested on Debian Linux
• Python3.6

Cloning the repository

git clone https://github.com/TonyKioko/NeighborHood && cd Awwards

Creating a virtual environment

python3 -m virtualenv virtual
source virtual/bin/activate

Installing dependencies

pip3 install -r requirements

Prepare environmet variables

For this project you will need the following configurations plus email setup for email registration hmac verification.

SECRET_KEY= #secret key will be added by default
DEBUG= #set to false in production
DB_NAME= #database name
DB_USER= #database user
DB_PASSWORD=#database password
DB_HOST="127.0.0.1"
MODE= # dev or prod , set to prod during production
ALLOWED_HOSTS='.localhost', '.herokuapp.com', '.127.0.0.1'

Database migrations

python manage.py migrate

Running the server

python manage.py runserver

Admin Dashboard

Use django admin to manage the different users and posts.

Deploying to heroku

Refer to this guide: deployment to heroku

Running the tests

python manage.py app test

Live Demo

The web app can be accessed from the following link: NeighborHood

Technology used

• Python3.6
• Django 1.11
• Heroku

Test Driven Development

• Testing was done using python inbuild test tool called unittest

Known Bugs

There are no known bugs.

License (MIT License)

This project is licensed under the MIT Open Source license,Copyright (c) 2018 Tony Kioko