iReporter

Overview

iReporter app enables users (citizen) to bring any form of corruption to the notice of appropriate authorities and the general public. Visit app url: https://irepot.herokuapp.com

• 1. 🚀 Getting Started
  • 1.1 Prerequisites
  • 1.2. Run locally
  • 1.3. Building
  • 1.4. Test Locally
  • 1.5. Running Test
• 2. 🔒 Authentication
• 3. API Versioning
• 4. HTTP Requests
• 5. HTTP Response Codes
• 🔖 6. Resources
  • 6.1. Authentication
  • 6.2. API Routes
• 7. 📝 License

1. 🚀 Getting Started

1.1 Prerequisites

NodeJS: https://nodejs.org

PostgreSQL: https://www.postgresql.org

1.2. Run locally

• To run app locally, make sure you have nodejs, postgres installed.

• Clone repository or clone your own fork

    git clone https://github.com/devdbrandy/iReporter.git
    cd iReporter
    cp .env.example .env
    npm install

• Create a PostgreSQL database for the project via pgAdmin or run the below command on your terminal:

    createdb -h localhost -p 5432 -U postgres ireporter

• Configure .env environment variable with your credentials

• Run migration npm run migrate

• (Optional) Seed dummy data npm run seed

• Two npm scripts are availiable to spin up the app server:

  • npm run dev spin up the server without watching for any file changes
  • npm run watch watches for any file changes and reloads the server

1.3. Building

npm run build

1.4. Test Locally

To test or consume api locally, you can make use of Postman or Insomnia

1.5. Running Test

Test specs are implemented using mocha + chai + sinon.

Make a duplicate of .env and rename to .env.test, then configure your test credentials.

Two npm scripts are available to run the test suite:

1. npm run mocha or npm run mocha:watch - The later watches for any file changes and runs the full test suite (without code coverage)
2. npm test - Performs a single full test suite run, including instanbul code coverage reporting. Summary coverage reports are written to stdout, and detailed HTML reports are available in /coverage/index.html

2. 🔒 Authentication

Access to restricted API endpoints requires an access token, iReporter uses access tokens to associate API requests with your account. To obtain your access token, make a request along with username and password credentials to https://irepot.herokuapp.com/auth/login

Sample Response:

POST https://irepot.herokuapp.com/auth/login
HTTP/1.1
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": 200,
  "data": [
    {
      "token": "...",
      "user": {}
    }
  ]
}

3. API Versioning

The second part of the URI specifies the API version you wish to access in the format v{version_number}. For example, version 1 of the API (most current) is accessible via:

  https://irepot.herokuapp.com/api/v1

4. HTTP Requests

All API requests are made by sending asecure HTTPS request using one of the following methods, depending on the being taken:

• POST Create a resource
• PATCH Update a resource
• GET Get a resource or list of resources
• DELETE Delete a resource

For POST and PATCH requests, the body of your request may include a JSON payload.

5. HTTP Response Codes

Each response will be returned with one of the following HTTP status codes:

• 200 OK The request was successful
• 400 Bad Request There was a problem with the request (security, malformed)
• 401 Unauthorized The supplied API credentials are invalid
• 403 Forbidden The credentials provided do not have permissions to access the requested resource
• 404 Not Found An attempt was made to access a resource that does not exist in the API
• 500 Server Error An error on the server occurred

🔖 6. Resources

6.1. Authentication

URI	HTTP Method	Description
/auth/signup	POST	Account signup
/auth/login	POST	Account login

6.2. API Routes

URI	HTTP Method	Description
/api/v1/users	GET	Fetch all users
/api/v1/users/{id}	GET	Fetch a specific user resource
/api/v1/users/{id}	PUT	Update a specific user resource
/api/v1/records	GET	Fetch a list of all records
/api/v1/red-flags	GET	Fetch all red-flag records
/api/v1/red-flags/{id}	GET	Fetch a specific red-flag record
/api/v1/red-flags	POST	Create a red-flag record
/api/v1/red-flags/{id}/location	PATCH	Edit red-flag's location
/api/v1/red-flags/{id}/comment	PATCH	Edit red-flag's comment
/api/v1/red-flags/{id}	DELETE	Delete specific red-flag
/api/v1/interventions	GET	Fetch all intervention records
/api/v1/interventions/{id}	GET	Fetch a specific intervention record
/api/v1/interventions	POST	Create an intervention record
/api/v1/interventions/{id}/location	PATCH	Edit intervention's location
/api/v1/interventions/{id}/comment	PATCH	Edit intervention's comment
/api/v1/interventions/{id}	DELETE	Delete specific intervention

7. 📝 License

The iReporter REST API is open-sourced software licensed under the MIT license.