/Neighborhood

App that allows users to post neighborhood alerts, businesses and has emergency contacts listed.

Primary LanguagePython

PROJECT NAME

NEIGHBORHOOD WATCH

AUTHOR NAME

TRACY OGUTU

PROJECT DESCRIPTION

This is a neighborhood watch application.It consists of various neighbourhoods.

Navigation pages include:

  • Sign up and Login Page

    • Users can create an account then log in to the application

  • _ Home Page_

    • Consists of a display of all neighborhoods posted by the administrator

    • Each neighborhood has the below properties:

      • Name
      • Location
      • Neighborhood image

    • It also has businesses and news alerts posted by the neighborhood members

    • Each business has:

      • Picture
      • Name
      • Editor
      • _Location

    • Each news alert has:

      • Title
      • Location
      • Description
      • Date posted

  • Single Profile Page

    • Authenticated Users can view their profile
    • Users can also edit thier profile
    • Profile details include:
      • Profile Photo
      • Location

  • Search results page

    • Results displayed by name of business or name of neighborhood

PROJECT SET UP INSTRUCTIONS

This project was generated with python version 3.6.8 and django version 1.11

Accessing the shell

Run `python manage.py shell' to use the shell

Accessing the database

Navigate to the root directory and type psql Type \l to view all present databases Run \c to be connected to a specific database Type \dt to view the tables Type SQL statements to interact with the database

Further help

To get more help on python, check out the python documentation at https://docs.python.org/3/library/

USER INTERACTION

  1. To run the application, type python3.6 manage.py runserver
  2. The authentication page will then be displayed
  3. Create an account then log in to the application
  4. The homepage will then be displayed
  5. Create a profile, post a news alert or business(es) owned
  6. Users can also find emergency contacts

TECHNOLOGIES USED

LANGUAGES

  • Python

  • Markdown

DATABASE

  • Postgresql

FRAMEWORK

  • Django version 1.11

  • django-bootstrap4

DEPLOYMENT

  • Heroku

CONTACT INFORMATION

Email: tracyogutu@gmail.com

Phone:+254 719 614 987

MIT License

Copyright (c) 2019 Tracy Ogutu

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.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

LINK TO HEROKU

https://hoodleash.herokuapp.com/