Last updated Apr 19, 2024

Extending the Speakeasy plugin

If you so desire to improve the Speakeasy plugin itself, here are some steps to do so. Note that you don't need to hack on the Speakeasy plugin to enter the contest.

Take the following steps to install the Speakeasy plugin:

  1. Clone (or fork) the github speakeasy-plugin project via:

    1
    2
    git clone https://github.com/mrdon/speakeasy-plugin.git
    
  2. Start the plugin in the desired product:

    • Refapp:

      1
      2
      mvn refapp:debug
      
    • Confluence:

      1
      2
      mvn refapp:debug -Dproduct=confluence
      
    • JIRA:

      1
      2
      mvn refapp:debug -Dproduct=jira
      
  3. Open pom.xml in IDEA

  4. Start the cli for rapid deployments:

    • Refapp:

      1
      2
      mvn refapp:cli
      
    • Confluence:

      1
      2
      mvn refapp:cli -Dproduct=confluence
      
    • JIRA:

      1
      2
      mvn refapp:cli -Dproduct=jira
      
  5. Visit the user profile page of Speakeasy:

    • Refapp:

      1
      2
      firefox http://localhost:5990/refapp/plugins/servlet/speakeasy/user
      
    • Confluence:

      1
      2
      firefox http://localhost:1990/confluence/plugins/servlet/speakeasy/user
      
    • JIRA:

      1
      2
      firefox http://localhost:2990/jira/plugins/servlet/speakeasy/user
      

To try out extensions, you can create a new one or work on the testing plugin found in src/test/resources. It is deployed via the tpi cli command (stands for 'test plugin install')

Rate this page: