office-addin-base

KO | EN

gitlite — search

#hacktoberfest #typescript #llm #machine-learning #rust #deep-learning #linux #java #windows #awesome #security #pytorch #ios #mcp

office-addin-base

(★ 11)

Base project for rapidly building Office Add-ins

office-addin-base Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# office-addin-base
[![devDependency Status](https://david-dm.org/patbuergin/office-addin-base/dev-status.svg)](https://david-dm.org/patbuergin/office-addin-base#info=devDependencies)

A base project for rapidly building [Office Add-ins](http://dev.office.com/getting-started/addins) with [Babel](http://babeljs.io/), [Sass](http://sass-lang.com/), and [Browsersync](https://www.browsersync.io/).

![Preview](https://raw.githubusercontent.com/patbuergin-zz/office-addin-base/master/doc/demo.gif)

## Setup
### Prerequisites
#### 1. Install Node.js
Download a suitable package from the [official page](https://nodejs.org/en/) and follow the instructions.

Please make sure that your [version supports ES6](https://nodejs.org/en/docs/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](http://bower.io/), [Gulp](http://gulpjs.com/), [Yeoman](http://yeoman.io/), and [generator-office](https://github.com/officedev/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:
```javascript
{
  "host": "...",
  "user": "...",
  "pass": "..."
}
```

## Run Your Add-In
TODO

office-addin-base

office-addin-base Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

office-addin-base

office-addin-base Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README