Electrode Native
Primary version
Primary version
  • README
  • INTRODUCTION
    • Overview
      • What is Electrode Native
      • What is a MiniApp
      • Electrode Native workflow
      • Native dependencies management
      • JS/Native communication
      • Requirements
      • Upgrading Electrode Native
      • Contributing
  • REFERENCE
    • Composite
    • [Container]
      • Overview
      • Generation
      • Publication
      • Transformation
      • Pipeline
      • Integration
      • Initialization
      • Launching MiniApps
    • Cauldron
      • Structure
      • Setup
      • Compatibility checks
      • Guidelines
    • Manifest
      • Override
      • Native Modules
      • Configurable Modules
    • Runner
    • APIs
      • Project Generation
      • Implementation
      • Versioning
      • Guidelines
    • Bridge
      • Message Types
      • Communication
      • Leveraging APIs
    • CLI
      • Global CLI
      • Local CLI
    • GLOSSARY
  • GUIDES
    • Debugging multiple MiniApps
  • CLI COMMANDS
    • add
    • bundlestore
      • create
      • delete
      • upload
      • use
    • binarystore
      • add
      • get
      • remove
    • code-push
      • patch
      • release
      • promote
    • compat-check
    • create-api-impl
    • create-api
    • create-composite
    • create-container
    • create-plugin-config
    • publish-container
    • transform-container
    • run-container-pipeline
    • create-miniapp
    • link
    • regen-api
    • regen-api-impl
    • run-android
    • run-ios
    • start
    • unlink
    • upgrade-miniapp
    • cauldron add
      • file
      • jsapiimpls
      • miniapps
      • nativeapp
    • cauldron config
      • get
    • cauldron del
      • file
      • jsapiimpls
      • miniapps
      • nativeapp
    • cauldron get
      • config
      • dependency
      • nativeapp
    • cauldron repo
      • add
      • clear
      • current
      • list
      • remove
      • use
    • cauldron update
      • file
      • jsapiimpls
      • miniapps
      • nativeapp
    • cauldron batch
    • cauldron regen-container
    • cauldron upgrade
    • cauldron why
    • github
      • github create-ref
      • github delete-ref
      • github align-dependencies
    • platform
      • plugins
        • list
        • search
      • config
        • set
        • get
        • del
        • list
      • install
      • versions
      • uninstall
      • use
Powered by GitBook
On this page
  • complete native application descriptor
  • partial native application descriptor
  • Electrode Native module name
  • package path
  • Container publishers
  1. REFERENCE

GLOSSARY

complete native application descriptor

A complete native application descriptor is a string with format [nativeAppName]:[platform]:[version]

  • nativeAppName : alphanumeric native application name , cannot contain character ':'

  • platform : one of android or ios

  • version : alphanumeric , cannot contain character ':'

partial native application descriptor

A partial native application descriptor is a string with format [nativeAppName], platform and version can remain optional.

  • nativeAppName : alphanumeric native application name , cannot contain character ':'

Electrode Native module name

The Electrode Native module name applies to modules created with Electrode Native cli.

  • Module names should be alphanumeric and cannot start with a digit or underscore

  • create-miniapp, create-api and create-api-impl commands allow passing Electrode Native module name as its arguments.

For example, ern create-miniapp mymovie-miniapp, ern create-api mymovie-api will create mymovie-miniapp and react-native-mymovie-api respectively.

package path

A package path is a string representing the path (local or remote) to a Node Package. In the context of Electrode Native, a few package path formats are supported (as illustrated by the following samples) :

Package in remote git repository:

  • git+ssh://git@github.com:electrode-io/movielist-miniapp.git

  • git+ssh://git@github.com:electrode-io/movielist-miniapp.git#0.0.9

  • https://github.com/electrode-io/movielist-miniapp.git

  • https://github.com/electrode-io/movielist-miniapp.git#0.0.9

For GitHub SSH urls it is also possible to use the default GitHub format:

  • git@github.com/electrode-io/movielist-miniapp.git

  • git@github.com/electrode-io/movielist-miniapp.git#0.0.9

The string following the optional # denotes a branch/tag or specific commit SHA.

Package on local file system :

  • file:/etc/movielist-miniapp

  • /etc/movielist-miniapp

Package on npm registry:

  • movielistminiapp

  • movielistminiapp@0.0.9

  • @myscope/movielistminiapp@0.0.9

Container publishers

The following Container publishers are currently available:

The README of each of these publishers contain information related to their usage and configuration.

PreviousLocal CLINextDebugging multiple MiniApps

Last updated 5 years ago

git
maven
jcenter
dummy