README.md

iReporter

Overview

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

Demo Users (Try It Out <> Click me! 😋)

Username	Password	Access
admin	secret	Admin Access
user123	secret	User Access

• Overview
• 🚀 Getting Started
  • Prerequisites
  • Run locally
  • Building
  • Running Test
• 📝 License

🚀 Getting Started

Prerequisites

Ensure that you have the following installed on your local machine:

• NodeJS

Run locally

• Clone repository or clone your own fork

    git clone https://github.com/devdbrandy/ireporter-frontend.git

• Navigate into the project directory: cd ireporter-frontend

• Run npm install to install required dependencies

• Make a duplicate of .env.example and rename it to .env

• Configure .env environment variable with the required credentials

• Run npm run dev to spin up the development server (supports Hot Reload)

Building

Run npm run build on your terminal to build the app

Running Test

Two npm scripts are available to run the test suite:

1. npm run test:watch - 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/lcov-report/index.html

📝 License

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