Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/machariamark/neighbourhood-watch
A web app that keeps you in the loop of what occurs in your neighbourhood.
https://github.com/machariamark/neighbourhood-watch
bootstrap-4 django html pip python-3-6 virtualenv
Last synced: 5 days ago
JSON representation
A web app that keeps you in the loop of what occurs in your neighbourhood.
- Host: GitHub
- URL: https://github.com/machariamark/neighbourhood-watch
- Owner: MachariaMark
- License: mit
- Created: 2021-10-29T07:23:46.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2021-10-30T22:50:15.000Z (about 3 years ago)
- Last Synced: 2024-11-10T00:38:10.616Z (5 days ago)
- Topics: bootstrap-4, django, html, pip, python-3-6, virtualenv
- Language: Python
- Homepage: https://neighbourhood-watch-beta.herokuapp.com
- Size: 30.7 MB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Neighbourhood Watch
29.10.2021
#### By **Mark Muchiri Macharia**
## Description
A web app that keeps you on the loop with the happenings in your neighbourhood.
## Features
As a user of the web application you will be able to:
1. Sign up and log in
2. Choose your neighbourhood
3. View posted alerts and post by other users from your neighbourhood
4. Post alerts and posts
5. Comment on a post
6. Edit your profile
7. See authorities and health services around
## Specifications
| Behavior | Input | Output |
| ------------------- | ----------------------------- | ----------------------------- |
| User visits the app and gets directed to the login page | User logs in | Directed to the home page |
If user has no account, they click on `sign up` | User signs up | User is redirected to the profile set up page |
| Homepage loads | Click `alerts` | User's taken to the alerts page|
| Homepage loads | Click `Neighbourhood Posts` | User's redirected to a page where they can see uploaded posts and a button to post too |
| Homepage loads | Click `Health Services` | User's redirected to a page where they can see health services |
| Homepage loads | Click `Businesses` | User's redirected to a page where they can see uploaded businesses |
| Homepage loads | Click `Authorities` | User's redirected to a page where they can see posted authorities in the same neighbourhood |
| Homepage loads | User inputs in the search form and presses enter | Searched results show |
## Getting started
### Prerequisites
* python3.6
* virtual environment
* pip
### Cloning
* In your terminal:
$ git clone https://github.com/MachariaMark/Neighbourhood-Watch.git
$ cd neighbourhood-watch
## Running the Application
* Install virtual environment using `$ python3.6 -m venv --without-pip virtual`
* Activate virtual environment using `$ source virtual/bin/activate`
* Download pip in our environment using `$ curl https://bootstrap.pypa.io/get-pip.py | python`
* Install all the dependencies from the requirements.txt file by running `python3.6 pip install -r requirements.txt`
* Create a database and edit the database configurations in `settings.py` to your own credentials.
* Make migrations
$ python manage.py makemigrations watch
$ python3.6 manage.py migrate
* To run the application, in your terminal:
$ python3.6 manage.py runserver
## Testing the Application
* To run the tests for the class file:
$ python3.6 manage.py test watch
## Technologies Used
* Python3.6
* Django
* HTML
* Bootstrap
## Support and contact details
For feedback contact me through;
* [email protected]
* 0759329269
### License
[MITlicense](LICENSE) 2021