StarterKit Plugin

StarterKit is a sample lightweight plugin which you can use as a starting point to create your own plugin.

Getting to Know the StarterKit Plugin

Use the links below to get to know the different aspects of the StarterKit plugin:

Topic	Description
Project Structure	An overview of the project structure
Component Approach	How the plugin is implemented through the use of web components
Router	The routing feature used and to configure routes
APIs	How to make API calls
Mocking	How to configure mock responses to API calls
Application Store	Utility class for storing data within your application
Translations	How to handle translations
Listeners	How to listen for and respond to events from Temenos Explorer

Creating a New Plugin from StarterKit

To create your own plugin from StarterKit, run one of the follow scripts in /TemenosExplorer/public/plugins/ based on your OS:

macOS/Linux/Unix

sudo create-plugin.sh

Windows

create-plugin.bat

The script will ask you to enter the name of your new plugin using sentence case, e.g. "MyNewPlugin".

The script will create a new plugin as a clone of StarterKit with name references updated to match the new plugin name.

Building Your Plugin

To build your plugin:

1. Open a terminal window
2. Move to your plugin folder
3. Run the command npm install to download and install package dependencies
4. Run the command npm run go to build and run your plugin

After completing step 4 a window should open in your browser loading your plugin.