https://github.com/icij/sao-datashare-plugin

This SAO generator will scaffold a Datashare plugin.
https://github.com/icij/sao-datashare-plugin

Last synced: 13 days ago
JSON representation

This SAO generator will scaffold a Datashare plugin.

• Host: GitHub
• URL: https://github.com/icij/sao-datashare-plugin
• Owner: ICIJ
• Created: 2020-08-06T17:54:50.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-01-07T11:19:24.000Z (almost 4 years ago)
• Last Synced: 2024-04-25T15:42:18.476Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 416 KB
• Stars: 0
• Watchers: 8
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# sao-datashare-plugin

[![Circle CI](https://circleci.com/gh/ICIJ/sao-datashare-plugin.png)](https://circleci.com/gh/ICIJ/sao-datashare-plugin)

> This [SAO](https://github.com/saojs/sao) generator will scaffold a Datashare plugin.

## Usage

All you need is Node/NPM on your system.

After running the generator, your project will contain:

* a valid `package.json` including name, description, scripts and correct dependencies ;

* a `tests/e2e` directory with the a boilerplate for your E2E tests ;

* a `nightwatch.js` file to use E2E tests with Firefox in headless mode.

### From NPM

This will use NPM package to scaffold a plugin inside a new directory:

```bash

npx sao npm:@icij/sao-datashare-plugin MY-PLUGIN-DIR

```

### From git

This will use this repository to scaffold a plugin inside a new directory:

```bash

npx sao icij/sao-datashare-plugin MY-PLUGIN-DIR

```

## License

MIT © [ICIJ](https://icij.org)