This is a neighborhood application that makes it easy for anyone in a particular neighborhood to be updated when it comes to anything that happens within the neighborhood. live site
This project is by no means complete. Therefore, don't be alarmed when you encounter bugs in any form. Development is ongoing
The user is able to;
-
Sign in to the application to start using it
-
Set up a profile about me and a general location and my neighborhood name.
-
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 their neighborhood when they decide to move out.
-
Only view details of a single neighborhood.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
These are the things you need to install the software and how to install them
virtual enviroment:
$ pipenv shell
or
$ python3 -m venv virtual ( or your selected virtual enviroment name )
- Make sure you have a stable internet to have the ability to clone the repository.
- Type the following command in your terminal to clone this repository
git clone https://github.com/thesmartcoder7/hoodwatch.git
If you are using SSH, use the following command
git clone git@github.com:thesmartcoder7/hoodwatch.git
When you run the commands successfully, you should have a local version of this repository.
- Make sure you have a stable internet for forking this repository.
- According to the license, you can fork this project. You need to click on the forking icon and it will be added as one of your repositories
Feel free to fork the project and have fun with it. Happy coding!
To get a development env running, you simply need the install all the packages reguired from either a requirements.txt file or a pipfile. First you need to activate your virtual environment
$pipenv shell
of
$ source virtualenvname/bin/activate
after that, install all the required depencencies
$ pipenv install //pretty much takes care of installing all depencies for you
Now that all your dependencies are installed, you need to create a local database for your project and run migrations, or use the database that django comes with by default. The Make file has instructions for this.
make migrate
After this, you can run the application using the commands that come in the make file. for this case, it is either of the following:
$ make
or
$ make run
or
$ python manage.py runserver
If you want to run tests for the entire project, you need only run this command:
$ make test
or
$ python manage.py test
- HTML5
- SCSS
- JavaScript
- Django
- Postgresql
Copyright (c) Samuel Martins - MIT Licence
- Twitter - @thesmartcoder7
- Linkedin - Samuel Martins
- Website - Samuel Martins
- blog - Samuel Martins