Giter Club home page Giter Club logo

inst377project's Introduction

Whizzper - Crime of PGC

Project Description

Our web application utlizes a collection of APIs to present crime data of Prince George's County Maryland. Users will be able to pinpoint various forms of crime throughout the county. The data reaches baack as far as 2017 and is as current as the present. Aside from seeing previous crimes, users will also be able to report new crimes through our Forms page; anonymously.

Whizzper Link

https://whizzper.herokuapp.com/

Target Browsers

We found it imparative to ensure that our application was versatile enough to be used by various devices and browsers. Users may be on the go when they need to report a crime, so we made sure our page was adaptable to mobile devices. Users also use various browsers such as Edge and Chrome, therefore we ensured our website can be used appropriately on different platforms.

  • Safari for IOS devices
  • Google Chome for desktop and mobile devices
  • Microsoft Edge

Manuals

Whizzper Developer Manual

Installation

Getting Started

Make sure you have the latest version of Node.js installed Clone the repository using a shell client, such as GitHub Desktop

git clone https://github.com/terrydiko/INST377Project.git

Dependencies

Install all node dependencies inside the application directory

  npm install

Npm packages include:

  • body-parser - Body parsing middleware of Node.js
  • express - Server framework of Node.js
  • mongoose - Database used for backend querying

Deployment

Change directory (cd) to the application folder and start the application server

npm run start-watch

Open your preferred internet browser and type in:

localhost:4000

Server API

Endpoints

GET:
  • GET requests can be retrieved from (crimes)[/crimes]
  • GET requests retrieves list of locally reported crimes
POST:
  • POST adds data to (crime)[/crime]
  • POST requests to data of crimeType, street address, longitude, and latitude

Current Bugs/Issues

  • Site has slow loading times due to server pulling data from API all at once.
  • The website requires no user credentials for access, which could lead to cyber security issues.
  • Users can filter crimes by type but not by street, date, etc.

Future Development

  • Include more filtering options on the main page to give the user more control over viewing data
  • Expand the website idea to other counties within Maryland such as Montgomery, Calverton, Anne Arundel
  • Allow user to input a date or another piece of information to get specific information from crimes mathcing the input

inst377project's People

Contributors

asmith089 avatar terrydiko avatar gabrielifeliz avatar jukeemout 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.