Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 1.74 KB

README.md

File metadata and controls

47 lines (33 loc) · 1.74 KB

Neighbourhood Application

By Melissa Malala

Description

This is a web application enables users sign up to it and interact with the various happening in their neighbourhood.

It allows users to:

  • Sign in with the application to start using it.
  • Set up a profile about themselves, enter a general location of where they live.
  • Find a list of different businesses in their neighborhood.
  • Find Contact Information for the health department and Police authorities near their neighborhood.
  • Create Posts that will be visible to everyone in their neighborhood.
  • Change one's neighborhood when they decide to move out.
  • Only view details of a single neighborhood.

Prerequisites

The following are needed for the application to run on a local computer:

  • python version 3.6
  • Django framework
  • Bootstrap v.3
  • Text editor (Pycharm,Atom, VS code or Sublime )
  • Web browser A crucial point to note: You will need Python version 3 and above installed on your laptop. If you don't have it installed got to Python.org to install.

Getting Started

  • Clone this repository to your local computer and install all the extensions listed in the requirements.txt file.
  • Ensure you have python3.6 installed in your computer.
  • From the terminal navigate to the cloned project folder.
  • Switch to the virtual environment by entering source virtual/bin/activate from the terminal.
  • Once inside the application, a user will be able to use the application.

Running the tests

To run the tests, run python manage.py test neighbourhoodapp

Deployment

To run local server run python manage.py runserver

License

This project is licensed under the MIT License - see the LICENSE.md file for details