Readme.md

Gluestack V2 Plugin Development

Important Notes:

1. Please checkout to the develop branch to access latest (beta) version. Thank You!
2. Please do not use Yarn or PNPM, we will only use npm as a package manager in Gluestack's v2.

Install npm dependencies

# Run this command from your project's root directory
$ npm run install-all;

Create plugin builds (in production mode)

# Run this command from your project's root directory
$ npm run build:plugins;

Create plugin builds (in development mode)

#
# You need to run below mentioned commands separately from your CLI
#
$ npm run watch:cli;
$ npm run watch:develop;
$ npm run watch:web;

Access Glue

# Run this command from your project's root directory
$ node glue
#
# And its output will be something like this:
#
Usage: glue [options] [command]

Gluestack V2 Framework CLI

Options:
  -V, --version                              output the version number
  -h, --help                                 display help for command

Commands:
  add|install <plugin-name> <instance-name>  installs a gluestack plugin, use help for more info on subcommands
  instance:list                              Prints the list of installed plugin instances
  plugin:list                                Prints the list of available plugins
  plugin:init                                Initializes the gluestack app as a plugin
  watch                                      Watches the instances for changes and restarts them
  help [command]                             display help for command