ExcelControlCharts

An Excel plugin for SPC charts and Funnel plots

Initialising the Development Environment

The repo uses submodules to include the PowerBI-SPC and PowerBI-Funnels sources, so be sure to clone those when setting a local copy of the repo:

git clone --recursive https://github.com/AUS-DOH-Safety-and-Quality/ExcelControlCharts

The dependencies for the submodules are also included in the main package.json file, so you can install them all at once (note that this may take a few minutes):

cd ExcelControlCharts
npm install

Developing Locally

From The Command Line

To run the development server, use:

npm run start

This will compile the plugin and start a local server that you can use to test the plugin in Excel. A blank spreadsheet will open with the plugin loaded, but it will also be available in any existing spreadsheets you have open.

From Visual Studio Code

VS Code also provides good support for the plugin development workflow. Start by installing the Office Add-ins Development Kit extension.

Next, create a new .vscode folder in the root of the repo (if one does not already exist) and add the files (or append their contents to your own) in the assets/vscode-configs folder to it. This will provide a launch configuration for debugging the plugin in Excel.

You can launch the plugin with debugging support by pressing F5 or selecting the "Preview Your Office Add-In" option from the Run menu:

This will perform the same steps as the npm run start command, but will also attach a debugger to the plugin - allowing for better support of logging and debugging: