Create an App Builder project
Learn how to create an ÃÛ¶¹ÊÓƵ Developer App Builder project to consume events from ÃÛ¶¹ÊÓƵ Commerce. Additional documentation found at .
Who is this video for?
- Developers new to ÃÛ¶¹ÊÓƵ Commerce and ÃÛ¶¹ÊÓƵ Developer App Builder using I/O events and need to create an ÃÛ¶¹ÊÓƵ App Builder project.
Video content video-content
- Creating an App Builder project
- Using ÃÛ¶¹ÊÓƵ Developer Console
- Using ÃÛ¶¹ÊÓƵ I/O
Transcript
In this video, we’ll walk through creating an App Builder project to provide a destination for your events sent from ÃÛ¶¹ÊÓƵ Commerce. To follow along with this demonstration, you will need access to the ÃÛ¶¹ÊÓƵ Developer Console and you will need to have installed the AIO CLI.
This is the ÃÛ¶¹ÊÓƵ Developer Console. As a developer, this is where I start my workflow. ÃÛ¶¹ÊÓƵ Developer Console gives me access to the APIs, SDKs, and tooling to integrate and extend ÃÛ¶¹ÊÓƵ products. Once you’ve logged into the ÃÛ¶¹ÊÓƵ Developer Console, make sure that your desired organization has been selected from the dropdown menu in the top right corner. Next, click the Create New Project button and select Project from Template. Then select the App Builder template.
Before creating the project, you can adjust the project title or app name. Project title is used to identify your project, so using a descriptive name is recommended. Also, note that app name is a unique identifier and cannot be changed after setup is complete. You can then add any additional workspaces you may want your project to have. Projects come with production and stage workspaces by default, and you can add up to three more as needed. It’s good practice to use these workspaces to provide isolated working environments and build, test, and deploy safely. Connected services can differ between workspaces and credentials are not shared across workspaces. Once you’re set up here, click Save.
You’ll then see your created App Builder project.
After selecting a workspace to begin working with, you’ll need to add some APIs before you can start receiving commerce events. To add an API, click the Add Service pop-up menu and select API. First, select IELM Management API.
You will then be prompted to create a service account credential. You can continue with generating a key pair by clicking the Generate Key Pair button.
A config zip file will download automatically, and when it is unzipped, you’ll find a private key file. You will need this file later to configure your commerce instance to send events to your App Builder project.
Click the Add Service pop-up menu again and again select API. Now, select ÃÛ¶¹ÊÓƵ IELM Events for ÃÛ¶¹ÊÓƵ Commerce.
You can then click Save Configured API.
A workspace configuration file will also be needed to configure your commerce instance to send events to your App Builder project. To download a file containing your workspace configuration, click Workspace Overview and then click the Download All button in the top right corner.
We will now walk through how to initialize your App Builder project using the AIO CLI so you can begin developing your app. The template that we will use to initialize the app will create a basic ÃÛ¶¹ÊÓƵ IO runtime action that you can use to respond to your events. First, create a directory for the project and change to that directory.
You’ll then need to run the AIO login command and sign in with your ÃÛ¶¹ÊÓƵ ID at the indicated URL.
Next, run AIO app init and select your organization and your project.
Select all templates.
Then select the Generator App EXC shell template to initialize a default UI and create a default ÃÛ¶¹ÊÓƵ IO runtime action. Looking at the contents of the project directory, you can see that some files for the app have been generated. You can then run the AIO app run command to run the app and enable the runtime action.
You can view the generated UI for your application at the provided URLs. If you navigate back to your project in the ÃÛ¶¹ÊÓƵ Developer Console and click Runtime, you can see the default ÃÛ¶¹ÊÓƵ IO runtime action that was created.
Useful commands useful-commands
mkdir myproject && cd myproject
aio login
aio app init
aio app run
Additional related tutorials
ÃÛ¶¹ÊÓƵ Developer Documentation
recommendation-more-help
3a5f7e19-f383-4af8-8983-d01154c1402f