Git Product home page Git Product logo

opensphere-plugin-example's Introduction

opensphere-plugin-example

This is an example of an external plugin to OpenSphere.

Getting Started

For ease of development, we have created opensphere-yarn-workspace which assists in developing across multiple projects.

After you set that up, your directory structure should look like this:

opensphere-yarn-workspace/ # your clone of opensphere-yarn-workspace
  workspace/
    opensphere/ # your clone of OpenSphere

This project has all the basic boilerplate for getting a plugin project started. Clone it into the workspace as a sibling to OpenSphere.

opensphere-yarn-workspace/
  workspace/
    opensphere/
    opensphere-plugin-example

Now rename it to opensphere-plugin-whatever-you-like. Just do not forget to update its name in package.json also!

Run yarn to install dependencies. Afterward, you can run tests with yarn test, however, the build itself still takes place in the opensphere project. Jump back to that project and use yarn build to pick up your plugin. Then view OpenSphere in your browser as you normally would.

Plugin Tests

This includes the same (slightly old now) Karma and Jasmine versions as the main OpenSphere project. However, you can change those to whatever you like! Just take note of how karma.conf.js is picking up the included files in the closureFiles variable and then passing those to the Karma config. You will need to do something similar for configuring other test runners.

opensphere-plugin-example's People

Contributors

bradh avatar btuttle avatar schmidtk avatar wallw-teal avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.