MyHood

Author

Joy Kolia

Description

A Django application that allows users know about their Neighborhood, businesses around and keeps them updated on events taking place around them.

Live Link

View Site

User Story

• Signup & signin to use the application
• 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.
• Leave My neighborhood when I decide to move out.
• View details of a single neighborhood.
• User is able to search for different businesses in the area
• Only the admin can create a new neighborhood with by signing into the app with the credentials: username: admin & password: admin

Prerequisites

You need the following to start working on this project: On your local system;

1. Python3.8
2. Django
3. Pip
4. Virtual Environment(venv)
5. A text editor

Development Installation

To get the code..

1. Clone the repository: git clone https://github.com/jLuseno161/Neighborhood-Watch.git

2. Move to the folder and install requirements cd Neighborhood-Watch

3. In the projects root directory, install the virtualenv library using pip and create a virtual environment. Run the following commands respectively:

   • pip install virtualenv
   • virtualenv venv
   • . venv/bin/activate
     • Note that you can exit the virtual environment by running the command deactivate

4. Download the all dependencies in the requirements.txt using pip install -r requirements.txt

5. Launch the application locally by running the command python manage.py runserver and copying the link given on the termnal on your browser.

   • To upload photos as admin, run the command python manage.py createsuperuser to create an admin account in order to post. Access to the admin panel is by adding the path /admin to the address bar.

6. Run tests by running the command python3.8 manage.py test hood

Technology used

• Python3.8
• Django
• Heroku
• Git
• Bootstrap 4.3.1

Known Bugs

• There are no known bugs currently but pull requests are allowed incase you spot a bug

Contact Information

If you have any question or contributions, please email me at [joyluseno0@gmail.com]

License

Copyright © 2021 JOY L. KOLIA