Getting Started

Easiest way to get started is by trying out our sandbox project.

npx degit bambuser/bam-app-sandbox#main my-bam-app
cd my-bam-app

npm install
npm run dev

requirements

• Node.js version 18 or higher

Next steps

Learn concepts

We recommend that you start by reading the App architecture and App manifest pages to get an understanding of what an app is and how it will run within the Bambuser platform.

Checkout more examples

We recommend to both look at and try out one or more specific examples that fits your use-case the best, you may choose from:

• Screens
• Tool
• Dialogs
• One-to-One
  • Virtual try-on provider

Choose your build tool

Bambuser provides an development environment that should make it easy to build and test your app within the Bambuser platform. You are free to use any build tool that you prefer, but we also provide blank templates targeting a specific development tool as an easy starting point.

Vite

This template uses Vite and requires Node.js version 18 or higher (preferably latest LTS version).

npx degit bambuser/bam-app-starter-vite#main my-project
cd my-project

npm install
npm run dev

After running the commands above your browser should automatically have been opened up the local Bambuser App Development UI available on http://localhost:5173/devenv/

Webpack

This template uses Webpack and requires Node.js version 16 or higher (preferably latest LTS version).

npx degit bambuser/bam-app-starter-webpack#main my-project
cd my-project

npm install
npm run dev

After running the commands above your browser should automatically have been opened up the local Bambuser App Development UI available on http://localhost:8080/devenv/

Other

Visit Bambuser App Development Environment and enter your app manifest and config.

The app code must also be made available to this environment by either running some local dev server or putting it on some public server.

See App Manifest for futher information of what you need to provide manually that otherwise would be loaded from the bam-app.config.js file.

Follow design guidelines

Bambuser provides a Figma Design Library that can be used by app developers and designers to build UI that follows our Design Guidlines.

There is also an implementation called Bam UI which can be a quicker starting point for app developers to build UI with. It also includes theming support that is connected with configurations made by merchants in the BamHub Theming UI.

Publish your app

Once you app is ready to go, you should deploy your application to your own remote servers. If you want your app to be publicly available, you can send it for review and if approved we will list it to Bambuser Marketplace.

Read more on how to publish your app.