office-addin-base

A base project for rapidly building Office Add-ins with Babel, Sass, and Browsersync.

Setup

Prerequisites

1. Install Node.js

Download a suitable package from the official page and follow the instructions.

Please make sure that your version supports ES6.

2. Open a Node-enabled console

Windows: Node.js command prompt

OSX/Linux: Terminal

3. Install Global Dependencies

In your console, enter the following command:

npm install -g bower gulp yo generator-office

This will install the global project dependencies Bower, Gulp, Yeoman, and generator-office.

Install Project Dependencies

In your console, change the current working directory to the office-addin-base project folder, and enter the following commands in your console:

npm install
bower install

This will install all local project dependencies as configured in package.json (npm) and bower.json (bower).

Create an Add-In Manifest

Enter the following command in your console:

yo office

Follow the instructions, and enter the following values when prompted:

Technology to use

Manifest.xml only (no application source files)

Add-in start URL

https://localhost:8443/

This will create a manifest that can be loaded in all supported Office products.

Gulp Tasks

gulp build

Creates a debug build in /debug.

gulp serve

Runs the build task, and serves the debug build at https://localhost:8443/.

gulp ship-build

Creates a production build in /ship.

gulp ship

Runs the ship-build task, and uploads the contents of /ship to an FTP server (default directory: /site/wwwroot).

For this to work, you need to create a file called ftp.json in the root directory:

{
  "host": "...",
  "user": "...",
  "pass": "..."
}

Run Your Add-In

TODO