# propeller-sharepoint

> A SharePoint deployer plugin for Propeller.

Latest version **1.1.0** (published 2017-05-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install propeller-sharepoint
pnpm add propeller-sharepoint
yarn add propeller-sharepoint
bun add propeller-sharepoint
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2017-05-25 |
| First published | 2016-11-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | @kyleschaeffer |
| Maintainers | kyleschaeffer |
| Keywords | sharepoint, gulp, propeller |

## Links

- npm: https://www.npmjs.com/package/propeller-sharepoint
- Repository: https://github.com/oldrivercreative/propeller-sharepoint
- Homepage: https://github.com/oldrivercreative/propeller-sharepoint#readme
- Issues: https://github.com/oldrivercreative/propeller-sharepoint/issues
- npm.io page: https://npm.io/package/propeller-sharepoint

## Dependencies (5)

- [gulp](https://npm.io/package/gulp.md) ^3.9.1
- [gulp-util](https://npm.io/package/gulp-util.md) ^3.0.8
- [gulp-spsave](https://npm.io/package/gulp-spsave.md) ^3.0.0
- [gulp-propeller](https://npm.io/package/gulp-propeller.md) ^1.2.0
- [gulp-exclude-gitignore](https://npm.io/package/gulp-exclude-gitignore.md) ^1.1.1

## Recent versions

- 1.1.0 (latest) — 2017-05-25
- 1.0.4 — 2016-12-14
- 1.0.3 — 2016-12-14
- 1.0.2 — 2016-11-07
- 1.0.1 — 2016-11-07

## README

# propeller-sharepoint
A SharePoint deployer plugin for [Propeller](https://github.com/oldrivercreative/propeller). This deployer uses [gulp-spsave](https://www.npmjs.com/package/gulp-spsave) to handle authentication and file transfers during deployment. This package is compatible with SharePoint 2013, SharePoint 2016, and Office 365/SharePoint Online environments.

## Getting Started
Install Propeller and propeller-sharepoint using [npm](https://www.npmjs.com/get-npm):
```sh
npm install gulp-propeller --save-dev
npm install propeller-sharepoint --save-dev
```

Create a `propeller.json` file in your project directory that contains your SharePoint connection information. Specify the connection type as `sharepoint`:
```json
{
  "environments": {
    "o365": {
      "type": "sharepoint",
      "src": "build/**",
      "dest": "_catalogs/masterpage/test",
      "gitignore": false,
      "connection": {
        "site": "https://mytenant.sharepoint.com/",
        "user": "hello@contoso.com",
        "pass": "mypassword"
      }
    }
  }
}
```

Create a [Gulp](http://gulpjs.com/) task to deploy your files:
```js
const gulp = require('gulp');
const propeller = require('gulp-propeller');
const propellersp = require('propeller-sharepoint');

gulp.task('default', function(){

  // add sharepoint deployer to propeller
  propeller.extend(propellersp);

  // deploy to 'o365' environment
  propeller.deploy('o365');

});
```

---

See the [Propeller documentation](https://github.com/oldrivercreative/propeller#readme) for more information.

---
_Source: https://npm.io/package/propeller-sharepoint · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._