Giter VIP home page Giter VIP logo

hoodwatch's Introduction

HoodWatch

A web application which allows users to connect to various neigborhoods

User stories

The user should be able to:

  • Sign in with the application to start using.
  • 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.

Prerequisites

  • Python3.6.7

Installation

To install, follow the following instructions;

    $ https://github.com/Doktatech/HoodWatch.git
    $ cd HoodWatch
    $ source virtual/bin/activate
    Install all the necessary requirements by running pip install -r requirements.txt (Python 3.6).
    $ ./manager.py runserver

Setting up the enviroment variables

create a .env file in the root folder and add the following variables in it.

    SECRET_KEY= #secret key will be added by default
    DEBUG= #set to false in production
    DB_NAME= #database name
    DB_USER= #database user
    DB_PASSWORD=#database password
    DB_HOST="127.0.0.1"
    MODE= # dev or prod , set to prod during production
    ALLOWED_HOSTS='.localhost', '.herokuapp.com', '.127.0.0.1'

Known Bugs

There are no known bugs as of the latest update

Technology used

License (MIT License)

This project is licensed under the MIT Open Source license, (c) Rewel Kinyanjui

hoodwatch's People

Contributors

doktatech avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.