# @fgpv/plugins

> Plugins for the RAMP viewer supported by the core team.

Latest version **0.0.3** (published 2019-02-04) · ISC license · 0 weekly downloads

## Install

```sh
npm install @fgpv/plugins
pnpm add @fgpv/plugins
yarn add @fgpv/plugins
bun add @fgpv/plugins
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2019-02-04 |
| First published | 2019-02-04 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 139.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | The RAMP Core Team |
| Maintainers | milesap |
| Keywords | plugins, RAMP |

## Links

- npm: https://www.npmjs.com/package/@fgpv/plugins
- Repository: https://github.com/fgpv-vpgf/plugins
- Homepage: https://github.com/fgpv-vpgf/plugins#readme
- Issues: https://github.com/fgpv-vpgf/plugins/issues
- npm.io page: https://npm.io/package/@fgpv/plugins

## Dependencies (1)

- [rxjs](https://npm.io/package/rxjs.md) 6.3.3

## Recent versions

- 0.0.3 (latest) — 2019-02-04

## README

# Plugins

Plugins for the [RAMP v3 Viewer](https://github.com/fgpv-vpgf/fgpv-vpgf).

## Build distribution files

`npm run build` will output all plugins to the `dist` folder.

## RAMP viewer code

Samples and automated testing use the ramp viewer code found in `bin/test/ramp`. 

## Contributing

This project uses the fork and pull model. Once forked, run `npm run init` from the project root directory to setup for first time use. 

### Running locally

`npm run serve` will start a dev server. Open a browser and navigate to **http://localhost:6001**.

Example: **http://http://localhost:6001/enhancedTable/samples/et-index.html**.

### Testing locally

`npm run test` will start a local selenium server and run tests in Chrome.

### Writing tests

Tests follow the [Page Object Pattern](https://martinfowler.com/bliki/PageObject.html). General page information not related to a plugin can go inside `bin/test/ramp.page.js`. Specific page information for a plugin goes into the page file in the plugins `tests` directory. Any file in a plugins `tests` directory that end with a `.spec.js` will be tested.

The testing framework is [Jasmine](https://jasmine.github.io/tutorials/your_first_suite.html). Selenium bindings to individual browsers are handled by [webdriverio](http://webdriver.io/api.html). Currently tests are only executed in Chrome locally, however cloud testing will be more rigorous.

Webdriver: http://webdriver.io/api.html
Jasmine: https://jasmine.github.io/tutorials/your_first_suite.html
PageObject: https://martinfowler.com/bliki/PageObject.html

## Hosted builds

Commits pushed to your forked repo can be built using travis-ci.org and deployed as a GitHub page. For example, commit `5ea8ac3126957a8d2999ea4f9fed209e6080b935` would be deployed to https://your_github_username.github.io/plugins/5ea8ac3126957a8d2999ea4f9fed209e6080b935.

There are a few steps you'll need to make for this to work:

Steps to get started:

1. Create a **personal access token** on GitHub with the `repo` scope selected.
2. Sign in to travis-ci.org with your GitHub account
3. Activate travis on your (forked) repo by visiting: https://travis-ci.org/your_github_username/plugins
4. On the travis settings page (https://travis-ci.org/your_github_username/plugins/settings) create an environment variable named `GITHUB_TOKEN` with the value of your GitHub access token.
    > travis-ci uses this token to deploy the build back to your forked repo. It is not accessible outside of travis-ci and remains private.

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