Akinon Release Notes (05/12/2025) are now live! Click here to learn what's new.
LogoLogo
API Reference
  • Home
  • Quick Start
  • Tutorials
  • Technical Guides
  • Release Notes
  • Glossary
  • Welcome to Akinon Technical Guides
  • ACC
    • ACC CLI
    • Create Application via CLI
    • Deploy Environment Variables
    • App Store for Developers
  • Omnitron
    • Product Types
    • Product Categorization
    • Splitting a Merged Order Item
  • Commerce
    • Shipping Rules Calculator
    • Data Source Shipping Options
    • Attribute Based Shipping Options
    • Filtering Products
    • Conversation & Messages
    • Sitemap Configuration
    • Weight-Based Product Sales
    • Group Attribute Sets
    • Contract Management
    • Find in Store for Whippy Ware
    • Plugins
    • Remote Price
    • E-mail Templates
    • Loyalty Accounts
    • Search Structure
    • User Segmentation & Rules
    • Promotions
  • OMS
    • Getting Started with OMS
    • Basic Setup
    • Scenarios
    • Capacity Feature
    • Package Management
      • Packages
      • Transfer
      • States
    • Commands
      • Packages
        • Package Command Parameters
        • DeAllocate Package Reservations Command
        • Channel Based Complete Packaging without Shipment Command
        • Complete Packaging with Shipment Command
        • Complete Packaging without Shipment Command
        • Package Refuse with Denial Reason Command
        • Product Not Found & Wrong Product Command
        • Product Not Found & Wrong Product Command Advanced
        • Package Packed for Refund Command
        • Block The Package For Action Command
        • Unblock the Package For Action Command
        • Update The Package’s Invoice
        • Manual Planning Command
      • Transfer
        • Transfer Order Advanced Command
        • Product for Transfer Not Found & Wrong Product Command
        • Transfer Delivered Command
        • Transfer Dispatch Command
        • Transfer Ready for Dispatch Command
        • Transfer Out Of Stock
      • Shipment
        • Shipment Order Command
        • Package Advanced Shipment Command
        • Ship The Package Command
        • Ship The Package without Shipment Integration Command
        • Update The Package’s Shipment Status Command
        • Update Shipment Info of Package Command
    • Inventory Locations & Engine
      • Properties & Domain Relation
      • Customization
      • Inventory Engine
    • Fulfillment
      • Shipments
      • Invoice Integration
    • Webhooks
      • Webhook Examples
        • Order Webhook
        • Package Webhook
        • Shipment Webhook
        • Stock Location Webhook
        • Transfer Webhook
    • Integrating OMS with Seller Center
  • Instore
    • Getting Started
    • Cash Register Integration
    • OTP (One Time Password) Process
    • Services
      • Password Reset Services
  • Marketplace Dashboard
    • N11 Marketplace Setup Configurations
    • Trendyol Marketplace Setup Configurations
    • Walmart Marketplace Setup Configurations
    • Amazon Marketplace Setup Configurations
    • Hepsiburada Marketplace Setup Configurations
  • Project Zero
    • Django
      • Basic Setup
      • Project Structure
        • Templates & Components
        • Private Dependencies
        • Omnife Project Submodule
        • Webpack
        • ESLint Rules
        • Bundles
        • Multilanguage & Translation
        • Environmental File
        • Custom Error Pages
        • Icon Font
      • Page Types
        • Static Pages & Flatpages
        • Account Page
          • Template Rendering in Account Pages
          • Forms & Validation
        • Basket Page
          • Redux Basket State
          • Basket Page - View
        • Checkout
          • Redux Checkout State
          • View & Template Rendering
          • Masking & Validation
      • Theming & Styling
      • Widgets
      • SEO Management
      • Extending Project Zero
    • Next.js
      • Basic Setup
      • Deployment
      • Static Assets
      • Plugins
      • Widgets
      • Icons
      • Localization
      • SEO Management
      • Advanced Usage
      • Data Fetching
        • Client
          • Account
          • Address
          • Basket
          • Checkout
          • Misc
          • Product
          • User
          • Wishlist
        • Server
          • Category
          • Flat Page
          • List
          • Menu
          • Product
          • SEO
          • Special Page
          • Widget
  • App Maker
    • Setup Your Environment
    • Plugin Quickstart
    • Create Project
    • Setup Existing Project
    • Deploy Project
    • Users and Roles
    • Add Public Key
    • App Maker CLI
    • Create App on Stores
      • Creating App on Apple App Store
      • Creating App on Google Play Store
    • Mobile App Framework
      • Configuration
      • Framework
      • Project Structure
        • Structure
        • Data Containers
        • Pages
      • Dependency Integration
        • Plugins
        • Akinon Plugin Adapter
  • Akifast
    • HPP
      • Getting Started
      • Authorization
      • Payment Session Creation
        • Key Points Before Creating a Payment Session
        • Creating Payment Session
        • Redirecting to the Payment Page
        • Errors Encountered During Payment Session Creation
      • Merchant Services
        • Shipping Query URL
        • Agreement Query URL
        • Other URLs
  • B2B
    • Getting Started
    • B2B Setup
  • Adds-on
    • Invoicer
      • Introduction
      • Invoice & Pay On Delivery Service
  • Channel App Template
    • Introduction
    • Installation and Usage
    • Development Steps
      • Folder Structure
      • Starting Step
      • Encoding the Sales Channel
        • Introduction
        • Setup
        • Products
        • Product Price
        • Product Stock
        • Product Image
        • Orders
        • Product Data
      • Adding a New Command to Akinon
      • Listening for External Requests
    • Architecture
      • Introduction
      • Integration
      • Services (Flows)
        • Introduction
        • Product Service
        • Price Service
        • Stock Service
        • Image Service
        • Order Service
  • Multi Regional Settings
    • Multi Regional Settings
Powered by GitBook

© 2025 Akinon. All rights reserved.

On this page

Was this helpful?

  1. App Maker

Plugin Quickstart

PreviousSetup Your EnvironmentNextCreate Project

Last updated 16 days ago

Was this helpful?

This page provides a comprehensive overview of the capabilities that users can unlock with Plugins in App Maker. By following a few straightforward steps, users can effortlessly create, publish, and utilize Plugins from projects beyond their own. Whether it's building custom functionalities or integrating third-party tools, the power of Plugins empowers users to enhance their App Maker experience effortlessly.

1

Create Plugin

To create the development environment for users to create their plugin, the following command should be executed 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 find the plugins they have created stored under the .plugins directory within the project.

2

Installation Scripts

All changes that will affect project files must be developed within the ./plugins/YOUR_PLUGIN_NAME/installation directory, specifically within the android and iOS files. For more information, please refer to .

3

Run Installation Scripts

To run the scripts developed on the installation layer, follow these two steps:

  1. First, execute the command plugin preview to preview the type of diff installation scripts will generate in project files. Use the following commands for Android and iOS respectively:

app-maker plugin preview android 
app-maker plugin preview ios
  1. After ensuring that installation scripts are running properly, users can proceed to edit the project files. To do this, run the command plugin run:

app-maker plugin run android 
app-maker plugin run ios

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

4

Integration

All integrations intended for the JavaScript scope, particularly Framework Services like Analytics and DeepLing, should be developed exclusively within this layer. For more information, please refer to .

5

Publish Plugin

1. Privacy Settings

In the ./plugins/YOUR_PLUGIN_NAME/package.json file, choose whether the plugin to be published is private by setting the private field to either true or false.

{
    "private":  true  // or "false" depending on your preference
}

2. Plugin Pack

Navigate to the directory ./plugins/YOUR_PLUGIN_NAME/ and pack the plugin in order to publish it on App Maker.

app-maker plugin pack

3. Plugin Publish

Next, go to the directory ./plugins/YOUR_PLUGIN_NAME/ and publish the plugin on App Maker using the following command:

app-maker plugin publish    

Keep in mind that the plugin will be published for the envVersion number specified in akinon.json.

6

Add Plugin

If the user wants to include a plugin that was developed for another project (different from their own), they need to follow these steps:

  1. Clone the Plugin: Clone the plugin's repository into the .plugins directory located within the main directory of the current project.

  2. Run the plugin add Command: After cloning the plugin, use the following command to add the plugin to the current project.

plugin add <name>
here
here