The Neighborhood

Built By Brian Mwenda

Description

This is a web application that allows users to join neighborhoods, create new neighborhoods, delete neighborhoods, update and create profiles. Users can communicate to other members in the neighborhoods they join.

Users must log in with credible emails

User Stories

These are the behaviors/features that the application implements for use by a user.

Users would like to:

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

Admin Abilities

These are the behaviours/features that the application implements for use by the admin.

Admin should:

Sign in to the application
Add, Edit and Delete hoods,posts,businesses
Delete hoods,posts,businesses
Manage the application.

Specifications

Behaviour	Input	Output
Admin Authentication	On demand	Access Admin dashboard
Admin Authentication	On demand, verify emails before proceeding	Access Admin dashboard
Display all neighborhoods,posts,businesses	Home page	Clickable links to open live neighborhoods,posts,businesses in different sites
To add an neighborhoods,posts,businesses	Admin/Users	Click on add and upload respectively
To edit neighborhoods,posts,businesses	Admin/Users	Redirected to the neighborhoods,posts,businesses form details and editing happens
To delete an neighborhoods,posts,businesses	Admin/Users	click on neighborhoods,posts,businesses object and confirm by delete button
To search neighborhoods by id	Enter text in search bar	Users can search by neighborhoods by ID
View posts by neighbours	Add posts	Users can add posts to neighborhoods they join

SetUp / Installation Requirements

Prerequisites

python3
pip
virtual
env
Requirements.txt

Cloning

Open your terminal and run the following commands:

git clone https://github.com/mwendaB/neighboorhood

cd neighboorhood

Running the Application

Creating the virtual environment

python3 -m venv --without-pip virtual

source virtual/bin/activate

Install pip to your virtual

curl https://bootstrap.pypa.io/get-pip.py | python

pip install -r requirements.txt

python3 manage.py runserver

Testing the Application

To run the tests for the class files:

python manage.py runserver

Technologies Used

Python3
Django framework and postgresql database

License

MIT