1. Install the Napps CLI
The Napps CLI requires Node.js 20.19 or later, or 22.12 or later. Install it from npm:napps command available in your terminal.
2. Create a new project
Create a project from a Napps template:napps new runs the same project generator. To skip the template prompt, pass a template and a project name:
Project names can use only letters, numbers, underscores (
_), and hyphens (-).
Then go into the project folder and install the dependencies:
@napps/component-extension. The package includes types for the Expresso APIs, runtime services, app extensions, product data, and supported components.
3. Understand the project layout
An App Extensions project usually looks like this:index.ts: the entry file. It exports the functions that Expresso can load.src/: contains your extension and component code.napps.config.json: lists your project’s extensions and components, with the name each one is exported under.package.json: contains your dependencies and thedev,build, anddeployscripts.tsconfig.json: contains the TypeScript configuration.
src/extension.ts and exports it from index.ts:
napps create-extensionadds an app extension. See App Extensions.napps create-componentadds a React UI component. See React UI.
src/, exports it from index.ts, and adds an entry to napps.config.json.
4. Start a development session
napps.config.json and inject them into the mobile application. The other choices, PDP, App Extension, and UI Node, start a development server for a single item of that type.
The CLI then shows how to connect the mobile application, by QR code or by direct URL.
5. Install the Napps mobile application
Install the Napps mobile application on your device:- Android: Google Play
- iOS: App Store
6. Connect the app to your dev session
Open the Napps mobile application, open the dev menu, and connect to your development session in one of these ways:- Scan the QR code shown by
napps dev. - Enter the direct URL shown by
napps dev.
Next steps
Keep the development session running while you edit your project, and follow the CLI output. If the app disconnects, scan the QR code or enter the direct URL again.- Learn how App Extensions work.
- Build custom UI with JS UI.