/NeighbourHood-Project

A Django web application that keeps you upto date on what's going on in your area. From handyman contact information to meeting notifications and even warnings

Primary LanguagePython

AUTHOR

BETH NDUTA

Nduts_neghborhood

A Django web application that keeps you up to date on what's going on in your area. From handyman contact information to meeting notifications and even warnings, there's something for everyone.

Overall Description

Project perspective

If you are like me, you really don't know what is happening in your neighborhood most of the time. What if an important meeting happens, theft or even death wouldn't you like to know about it. Your task is to design a web application that keeps you informed about what's going on in your neighborhood. From handyman contact information to meeting notifications and even warnings.

User stories

As a user I would like too:

  1. Sign in with 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 site

SEtup Instructions/Installation

Getting Started

Prerequisites

  • Python and pip (Python 3.10.5)
  • Install Git on your machine
  • Have a code editor
  • Use sql3 for database

Installation and Running the App

  1. Clone GitHub repository git clone https://github.com/bethnduta/NeighbourHood-Project.git
  2. Cd into the folder jirani
  3. Create a virtual environment pip install virtualenv
  • activate virtual environment env\Scripts\activate
  1. Add your credentials to the .env file
  2. Migrate your database
  • python manage.py migrate 7 Install the required dependencies
  • pip install -r requirements.txt
  1. Run the app
  • python manage.py runserver

Tests

  • To run the tests -- python manage.py test

Technologies used

  • Python-3.10.5
  • Django web framework
  • PostgreSQL
  • Imagefield
  • Bootstrap4
  • HTML5
  • CSS3

LICENSE

MIT License

Copyright (c) 2022 Beth Nduta Kiarie

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.