Skip to content

Latest commit

 

History

History
55 lines (34 loc) · 2.02 KB

README.md

File metadata and controls

55 lines (34 loc) · 2.02 KB

App Name :

Hood Alert

Description

An application that allows users to be in the loop about everything happening in your neighborhood. From contact information of different handyman to meeting announcements or even alerts.

Author

virginiah periah [https://github.com/virginiah894]

Application Features and BDD

As a user of the web application you will be able to:

  • Sign up and log in
  • Choose your neighbourhood
  • View posted alerts and post by other users from your neighbourhood
  • Post alerts and posts
  • Comment on a post
  • Edit your profile
  • See the different services around your neighborhood like schools and hospitals

Setup and installation

Getting Started Fork this repository or clone it to your local machine on ubuntu use the following commands git clone this repository at [https://github.com/virginiah894/Hood-alert]

Installations

Python version 3.6 Installation guide

Django version 3.0 see installation details here[https://docs.djangoproject.com/en/3.0/topics/install/]

virtual environment using these steps for linux: * sudo apt-get install python3-pip * sudo pip3 install virtualenv * virtualenv venv * source venv/bin/activate

postgres database

create a .env file and add SECRET_KEY='random-string generated by django in the settings.py file' DEBUG=True ALLOWED_HOSTS='*' DATABASE_URL='postgres://databaseowner:password@localhost/databasename' create a database using postgres CREATE DATABASE python3 manage.py runserver and ctrl + c on the link on the terminal to see the website on localhost [http://127.0.0.1:8000/]

Technologies Used

Python 3.6 Django 2.2 Bootstrap 4 CSS HTML5

KNOWN BUGS

  • If you encounter any bug (the website couldn't handle the query and or gave undesired results), kindly open an issue here by including your search query and the expected results.

If you'd like to request a new function, feel free to do so by opening an issue here. Please include sample queries and their corresponding results.

License

MIT