Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bonface221/neighbourhood
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 Job is to create a web application that allows you to be in the loop about everything happening in your neighborhood. From contact information of different handyman to meeting announcements or even alerts.
https://github.com/bonface221/neighbourhood
django python
Last synced: 6 days ago
JSON representation
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 Job is to create a web application that allows you to be in the loop about everything happening in your neighborhood. From contact information of different handyman to meeting announcements or even alerts.
- Host: GitHub
- URL: https://github.com/bonface221/neighbourhood
- Owner: bonface221
- License: mit
- Created: 2022-06-18T06:48:49.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-06-23T09:19:25.000Z (over 2 years ago)
- Last Synced: 2023-03-03T21:32:47.117Z (over 1 year ago)
- Topics: django, python
- Language: JavaScript
- Homepage: https://neighborhood221.herokuapp.com/
- Size: 1.97 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Neighbourhood
An application where users can:
* User Authentication
* 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.
* Change My neighborhood when I decide to move out.
* Only view details of a single neighborhood.
## Getting Started
* Fork the repository
* git clone the project to your local machine
* Set up a virtual environment in the project folder
```
$ pipenv shell
```
### Prerequisites
*get pipenv
```
Debian- sudo apt install pipenv
```
```
Windows- pip install --user pipenv
```
```
Locate python interpreter
$ pipenv --py
/Users/kennethreitz/.local/share/virtualenvs/test-Skyy4vre/bin/python
```
*get all requirements in the Pipfile.lock
```
$ pipenv install
```
### Installing
Ensure that the MODE in the .env is set to development ('dev'), which will automatically set debug to true.
Now run the following command
```
python3.9 manage.py runserver
```
And view the site at the port provided which is most likely 127.0.0.1:8000
## Running the tests
To run the automated tests for this system, run the following command
```
python3.9.12 manage.py test base
```
## Deployment
To deploy on heroku:
* Have a Procfile in the project root;
* Update requirements.txt file with all the requirements in the project root;
* Have Gunicorn to requirements.txt;
* Have runtime.txt to specify the correct Python version in the project root;
* Ensure configuration whitenoise to serve static files.
* Add a heroku remote by logging in
* Configure all the settings in .env on heroku (set MODE to 'prod' on heroku)
* git push to heroku
* git push database and migrate to heroku server
## Built With
* Python Programming Language
* Django Web Framework
## Versioning
Find all the versions used in the pipfile
## Authors
* **Bonface221** - [Neighbourhood](https://github.com/bonface221/neighbourhood)
## License
This project is licensed under the [MIT License](./LICENSE)
## Acknowledgments
* My Technical Mentors here at Moringa