@ordergroove/smi-serve

@ordergroove/smi-serve

smi-serve is a CLI tool to scaffold and run a local dev environment for Ordergroove's Subscription Manager templates.

Installation

Before using smi-serve, ensure you have Node.js installed on your system. If not, you can download and install it from nodejs.org. The smi-serve tool requires Node 18 or later.

Usage

To use smi-serve via npx, follow the instructions below:

1. Initialization

To initialize the current directory with assets from Ordergroove RC3 and start the development server, use:

npx @ordergroove/smi-serve init

This command initializes the current directory with assets from Ordergroove RC3 and starts a development server for serving the initialized assets. Any initialization errors will be displayed. Options:

• -y Answer all prompts as yes and silent the prompts
• --force or -f Force override local files if present

2. Start the Development Server

If no command is specified, the default behavior is to start the development server. This can also be explicitly invoked using:

npx @ordergroove/smi-serve serve

This command starts the development server and serves assets. The server's behavior can be modified using various options.

3. Deploy Changes to Ordergroove

To deploy changes to Ordergroove, use the deploy command:

npx @ordergroove/smi-serve deploy

This command deploys changes to Ordergroove based on the configured settings. Ensure you have the necessary authentication and configuration set up.

4. Select a new merchant

If you have access to multiple merchants, you can use the select-merchant command to switch to a new merchant. This can be useful if you manage multiple merchant accounts and would like to deploy changes from one merchant to another merchant.

npx @ordergroove/smi-serve select-merchant

This command allows you to select a new merchant from those available with your Ordergroove credentials.

Options

You can use a configuration file (.ogrc.json by default) to store settings from the command line. The following option is available:

--configFile or -c: Specify the path to the Ordergroove configuration file. Defaults to .ogrc.json.

This config is auto generated when you login and placed into the current working directory.

---

The program provides several options to customize its behavior:

• --verbose or -v: Enable verbose logging.
• --outdir or -o: Specify the output directory for build artifacts. Defaults to node_modules/.smi-serve-build.
• --port or -p: Specify the HTTP port for the development server. Defaults to an available free port.
• --env or -e: Specify the Ordergroove environment: prod or staging. Defaults to prod.
• --impersonate or -i: Enable customer impersonation.

Example usage with options:

npx @ordergroove/smi-serve serve --verbose --port 8080 --production