Git Product home page Git Product logo

neighbourly's Introduction

neighbourly

neighbourly An web application to know what's happening in your neighbourhood and find local businesses.

Getting Started

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.

Installation

OS X

Pre-requisites

Steps

  • Clone the app to a directory.
git clone https://github.com/tc-mwangi/neighbourly.git
  • Build Locally
$ python -m venv virtual
$ source virtual/bin/activate
$ pip install -r requirements.txt
$ DEVELOPMENT=1 python manage.py runserver
  • Serve
Then visit http://localhost:8000 to view the app. 

User Stories

  • As a User I would like to:

  • Sign in with the application

  • Set up a profile with general location and neighbourhood name

  • Find a listing of different businesses in my neighbourhood

  • Find contact information of Police and Health services

  • Create Posts visible to members of the neibourhood.

  • Change Neighbourhood when I decide to move out.

  • Only view details of a single neighbourhood.

BDD

Behaviour Input Output
1. login registered User display login form redirect user to their profile page
2. sign up new User display sign up form save user details, redirect to signup, redirect to login after signup
3. enable edit profile display edit profile form save, display changes on user's profile page and also on timeline
4. see listing of neighbourhood businesses display list of businesses and their contact details
5. post on the neighbourhood thread display post form update neighbourhood thread

Authors

License

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

Photo Credits

neighbourly's People

Watchers

 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.