Skip to main content

Quickstart Plugin

1 - Create Plugin

In order to create the environment where you will develop the plugin, run the following command in the project's root directory.

app-maker plugin create

Plugin names must be unique and comply with the akinon-react-native-camera formatting. Users can see the plugin created under .plugins.

2 - Installation Scripts

All changes that will influence project files must be developed within the android and iOS files under ./plugins/YOUR_PLUGIN_NAME/installation. Please see for more information 3 - Run Installation Scripts

There are two steps to running the scripts developed on the installation layer.

  1. Run the command plugin preview to see what kind of diff installation scripts will generate in project files.
app-maker plugin preview android && app-maker plugin preview ios
  1. After making sure that installation scripts are running properly, users can edit the project files. To do this, run the command plugin run.
app-maker plugin run android && app-maker plugin run ios

To run the plugin's Post Install scripts, add the —-post-install parameter.

4 - Integration

All integrations to be used for javascript scope, especially Framework Services such as Analytics and DeepLing, must be developed on this layer. Please see for more information

5 - Publish Plugin

  1. Private Field Select if the plugin to be published is private.
// ./plugins/YOUR_PLUGIN_NAME/package.json
{
    private: true / false
}
  1. Plugin Pack Go to the directory ./plugins/YOUR_PLUGIN_NAME/ and pack the plugin to publish it on App Maker.
app-maker plugin pack
  1. Plugin Publish Go to the directory ./plugins/YOUR_PLUGIN_NAME/ and publish the plugin on App Maker.
app-maker plugin publish

The plugin will be published for the envVersion number in akinon.json.

6 - Add Plugin

If the user wants to add a plugin developed for another project other than their own, they can clone the plugin to the .plugins directory in the project's main directory and run plugin add command.

plugin add <name>