Welcome to Robo Report! This app serves to increase awareness of the widespread issue of unwanted robo-calls and malicious telemarketers. In addition raising awareness, this app enables users to submit reports from within the app directly to the FCC and eliminate the need to include their contact information time and time again. Utilizing React and Electron, RoboReport is built as a desktop application due Node.js libraries required by Nightmare.js, a browser automation utility that this app uses to complete the FCC Complaint Form for Unwanted Calls. For questions, reach out on GitHub to Jon Sweet or Matt Renn.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- This app requires that you have Node.js installed locally.
- A Firebase account
- JWT access to the RoboReport API
- This API is restricted to code owners, and access will be given out on a VERY limited basis.
You may use NPM or Yarn - just stick to ONE of the two. Instructions listed here use NPM.
Clone down this repo.
git clone https://github.com/JSweet314/robo-report-client.git
Change in to the project directory and install dependencies.
cd robo-report-client && npm install
Create a .env file in the root of the projects and add your Firebase API key and RoboReport API token with the following format
REACT_APP_ROBO_TOKEN=<YOUR ROBOREPORT API TOKEN>
REACT_APP_FIREBASE_API_KEY=<YOUR FIREBASE API KEY>
Start the development server with the command
npm run dev
Please see the Electron docs for details on packaging Electron apps for production
The testing suite can be run with the command
npm test
- ReactJS - UI/View Framework
- Redux - Application State Management
- Electron - JavaScript Desktop App Framework
- Nightmare - Browser Automation Library
- Victory - React.js Charting Library
- Moment - JavaScript Date/Time Library
- Firebase - For User Authentication (OAuth)
- Jonathan Sweet - JSweet314
- Matt Renn - rennmatthewp