https://github.com/sumanjs/sce-plugin-template

Template for creating custom Suman Chrome Extension plugins.
https://github.com/sumanjs/sce-plugin-template

developer-experience developer-tools dx selenium selenium-webdriver suman suman-chrome-extension sumanjs web-development

Last synced: 27 days ago
JSON representation

Template for creating custom Suman Chrome Extension plugins.

• Host: GitHub
• URL: https://github.com/sumanjs/sce-plugin-template
• Owner: sumanjs
• Created: 2018-02-13T22:47:36.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-11-25T00:34:58.000Z (about 6 years ago)
• Last Synced: 2024-11-18T22:01:30.856Z (3 months ago)
• Topics: developer-experience, developer-tools, dx, selenium, selenium-webdriver, suman, suman-chrome-extension, sumanjs, web-development
• Language: JavaScript
• Homepage:
• Size: 43 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


# SCE Plugin Template

 Use this repo as a template for creating your own Suman Chrome Extension plugin. 

# Basic info

You can clone this project, make your changes, then push to Github, and 

Github can host your plugin.

To load your plugin from Github, you use a link like so:

https://rawgit.com/sumanjs/sce-plugin-template/master/dist/plugin.js

in general terms, that is:

`https://rawgit.com////dist/plugin.js`

Using the branchname (like "master") is fine since SCE will reload your plugin

from the URL everytime the app is loaded - caching is off in the browser, since

SCE uses `fetch(url, {cache:'no-store'})`.

However, caching might be on from the Github standpoint, and in that case, use the commit hash or develop

your plugin on localhost before publishing.

# Requirements

1. Install typecript `npm install -g typescript`

2. Install webpack `npm install -g webpack`

# Devloping your plugin

To develop your own plugin, do it locally.

1. Clone this project using https.

2. Use `src/index.ts` as the entrypoint of your plugin - you must export `SCEPlugin` as a class from index.ts.

3. Build your plugin using `./scripts/build.sh`

4. Locally, serve your plugin to SCE, using `./scripts/dev.sh`

5. Open SCE using Chrome, and then on the homepage click settings, paste the URL to your plugin and click load plugin.

6. Your plugin can be hosted locally with localhost, or on Github or Gitlab.

# Watch this video

See this video for a step-by-step guide to developing your own plugin for SCE:

[tbd]