Skip to main content

Environment Setup

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

PREREQUISITES
  • Ultimate subscription to Showpad
  • Administrator access to a Showpad organization with the following enabled:
    • Showpad Apps
    • Showpad App Portal API
  • Familiarity with frontend web technology and APIs
caution
  • When Showpad Apps is enabled, you can not create new Experiences and upload them via the Online Platform or Experience App CLI.
  • Existing Experience Apps can still be updated via Update Info, but we highly recommend migrating them to Showpad Apps.

Now that all the advanced planning has been completed, it's time to get your development environment set up. The following sections will walk you through it.

Authentication

Showpad Apps use the Showpad API and web services, so they must be registered as clients with a defined scope. The OAuth clients section describes how to register your OAuth client(s), as well as detailed explanations of each scope.

The minimum defined scope for Showpad Apps is:

  • View content related resources
  • Edit content related resources

Developer Organization

To create a Showpad App, you must have a Showpad developer organization (account). This is the first step to deploying and managing your apps, including updating versions. It also enables you to deploy your app to multiple other organizations.

process

When you upload a Showpad App to your organization, the app is automatically assigned to it. From there, you can then assign it to other Showpad organizations.

note

In order to be assigned an app, Showpad Apps must be enabled in an organization.

Code Editor

A reliable code editor is essential to write your code quickly and efficiently. We highly recommend using Visual Studio Code, but you're free to use your preferred code editor.

Node.js

Node.js is a cross-platform, open-source JavaScript runtime environment. You can download the Node.js source code or a pre-built installer for your platform from the Node.js download page.

Transpiler

When using modern versions of ECMAScript, you should transpile your code in order to ensure maximum compatibility with browsers. We recommend that you use Babel or other similar tools.

Showpad Developer Toolkit

The next section will provide an overview of the Showpad Developer Toolkit and the goodies we have for you.