Developers

Get started with your module

The five steps after reserving a name: redeploy your app, install the DashNex CLI, pull your app, create the module folders, then build your module and submit it for review.

After you reserve a module name, there are five steps from an empty reservation to a module in review. They are informative only: DashNex doesn't track which ones you have done.

1. Deploy your app

The business owner starts the redeploy. App shows the amber Redeploy required notice, and the Dashboard alert links to it. The redeploy installs @dashnex/dev, the module that connects your app with business.dashnex.com. See Dev module for what it does.

2. Install the DashNex CLI

npm i -g dashnex

3. Pull your app

dashnex app pull

4. Create your module folders

dashnex module init

This creates a packages/[address] folder from the module template for the names you choose, or for all of them with --all. See dashnex module init in the DashNex CLI guide.

5. Build your module

Build your module by following the developer docs in the module template wiki. When it is ready, submit it for review:

dashnex module submit [name]

What happens next is covered in Submit for review.

Where to find these steps

  • The confirmation that appears after each reservation.
  • The module page, while the module is Reserved.
  • This guide, in the Guide panel on your module's page.

Before you run module commands

Module commands act on the business you are currently working in. Run dashnex login to sign in and dashnex switch to pick the business that has the Developers program active and your reserved name. If a command stops with a message, see the access check in the DashNex CLI guide.

Related guides