Git Product home page Git Product logo

ireporter's Introduction

iReporter

iReporter is an web platform that enables any/every citizen to bring any form of corruption to the notice of appropriate authorities and the general public and also report on things that needs government intervention.

Build Status Maintainability Coverage Status Github issues GitHub

Required Features

  • Users can sign up
  • Users can login
  • Users can make a new report (A red flag or intervention)
  • Users can edit their reports
  • Users can delete their reports
  • Users can add geolocation to their report
  • Users can change the geolocation of their report
  • Admin can change status of the report (drafted, under investigation, resolved, rejected)

Technologies

  • Node JS
  • Express
  • Mocha & Chai
  • ESLint
  • Babel
  • Travis CI
  • Code Climate & Coveralls

Requirements and Installation

To install and run this project you would need to have installed:

  • Node Js
  • Git

To run:

$ git clone https://github.com/Chrismarcel/iReporter.git
$ cd iReporter
$ npm install
$ npm start

Testing

$ npm test

Pivotal Tracker stories

https://www.pivotaltracker.com/n/projects/2227345

Template UI

You can see a hosted version of the template at https://chrismarcel.github.io/iReporter/UI

API

The API is currently in version 1 (v1) and is hosted at https://ireporter-api.herokuapp.com/api/v1

API Endpoints

Endpoint Functionality
GET /red-flags Fetch all red-flags reports
GET /red-flags/<red-flag-id> Fetch the details of a single red-flag
PATCH /red-flags/<red-flag-id>/location Update the location of a red-flag report
PATCH /red-flags/<red-flag-id>/comment Update the comment of a red-flag report
DELETE /red-flags/<red-flag-id> Delete a single red-flag

Author

James Chrismarcel

License

This is licensed for your use, modification and distribution under the MIT license.

ireporter's People

Contributors

chrismarcel avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  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.