Skip to content

Latest commit

 

History

History
73 lines (49 loc) · 1.6 KB

README.md

File metadata and controls

73 lines (49 loc) · 1.6 KB

PhishingReporter

Microsoft Outlook Add-in to report phishing or scam emails.

Developed using the Yeoman generator for Office Add-ins.

Screenshot

Screenshot

Requirements

  • Node.js
  • Outlook 2016 or later on Windows

Getting started

Clone this project

git clone https://github.com/ntaylor-86/PhishingReporter.git

Install the dependencies

npm install

Create your .env file

cp .env.example .env

Enter your environment variables into the .env file

# This variable will appear in the new message subject
COMPANY_NAME=""

# This variable will appear in the To address for the new message
SUPPORT_EMAIL_ADDRESS=""

Try it out

Run the following command in the root of the project.

npm start

In Outlook, view a message and see the newly sideloaded add-in appear in your ribbon.

Building for production

Open your webpack.config.js file and add update your version.

const version = "1.2.0.0"; // CHANGE THIS TO YOUR PRODUCTION DEPLOYMENT VERSION

Also change your production URL to suit.

const urlProd = "https://contoso.com.au/v" + version + "/"; // CHANGE THIS TO YOUR PRODUCTION DEPLOYMENT LOCATION
const urlProdShort = "https://contoso.com.au/v" + version; // CHANGE THIS TO YOUR PRODUCTION DEPLOYMENT LOCATION

After your webpack.config.js has been updated run the following command:

npm run build

A new dist folder will be created in the root of the project. Upload these files to your production web server.