Hood_Watch

An application that is used to keep a user in the loop about things in a neighbourhood.

Author

By Immanuel Mugambi

Description

This is a web application that allows you to be in the loop about everything happening in your neighborhood.

User Stories

As a user I would like:

to Sign in with the application to start using.
to Set up a profile about me and a general location and my neighborhood name
to find a list of different businesses in my neighborhood.
to create Posts that will be visible to everyone in my neighborhood.
to change My neighborhood when I decide to move out
to view details of a single neighborhood.

Technologies Used

Python3.6
Django framework
Bootstrap
PostgreSQL

Setup/Installation Requirements

Prerequisites

Internet access
git clone
cd HoodWatch

To install a virtual environment

virtualenv -p /usr/bin/python3.6 virtual
source virtual/bin/activate

To install all dependencies

python3.6 -m pip install -r requirements.txt

To change the config_name parameter from 'production' to 'development'

Run python3.6 manage.py runserver to get the app running navigate to http://127.0.0.1:8000/ and it will open in your browser

Dependancy Installments

pip3 install python3.6
pip3 install django==1.11 django-heroku gunicorn pillow whitenoise python-decouple psycopg2-binary django-bootstrap3

Specifications

To see the projects specifications refer to the SPECS.md file for more details.

Coming Up

Deployment and other features

Known Bugs

It does not have bugs.But if any problems should occur, email me at [email protected]

N/B Also it is not finished yet...more features and functionalities are still being worked on.

Support and Contact Details

You can reach out to me at [email protected] for Reviews, Advice, Collaborations and Comments

Licence

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

imma7 / hood_watch Goto Github PK

hood_watch's Introduction