Quickstart: Create an app in five minutes

If you are already experienced with JavaScript tooling and want to dive right in and figure things out as you go, this is the quickest way to get started:

Use this quick-start guide to build, deploy, and publish a simple app in Security Scorecard's Integrate360° Marketplace, using a basic app template.

What you need

Before you start, make sure you have the following:

  • Node.js
  • Account with a cloud services provider, such as Amazon, Google Cloud or Vercel.
  • SecurityScorecard account

Build the simple app

Download and install the SecurityScorecard command-line interface (CLI), using your preferred package manager:

yarn global add @securityscorecard/cli
npm install -G @securityscorecard/cli

Configure your development environment:

ssc config

📘

Token

Generate a SecurityScorecard API token.

Initialize your app project:

ssc init
# or specify the example
ssc init -e experimental-bare-app

And then select experimental-bare-app from the list of options displayed by the CLI.

Edit the manifest at /public/manifest.json with three key details:

  • Public URL of your app where it is hosted on your cloud service
  • Public URL of your manifest
  • Your name or your organization's name in the developer field
  {
    // URL where you contain/expose your manifest
   "url": "https://company.com/manifest.json",
    // Your project's name
   "name": "Experimental Bare App",
   "developer": {
       // Developer/Maintainer site
      "websiteUrl": "maintainer.com"
   },
   "namespace": "experimental_bare_app",
   "description": {
       // A description text that will be visualized on yours app details
      "long": "application only for experimental purposes only",
       // A description text that will be visualized on a thumbnail
      "short": "experimental bare app"
   },
   "displaySettings": {
       // A URL with your projects/company logo
      "logoUrl": "https://company.com/logo",
       // Base URL of your project
      "homepageUrl": "https://company.com"
   }
}

📘

Manifest

The manifest defines the particular characteristics of your app, and each app template has its own unique manifest. Learn how to set specific attributes for signal app or action app manifests, depending on the type of production app you want to build.

Deploy your app.

To verify successful deployment, go to the address declared previously in the URL field (manifest.json) and verify that the manifest is obtained correctly.

Install your app so that it appears in Integrate360° Marketplace:

ssc install

👍

Success

To verify successful installation, go to the URL for your installed app displayed on the CLI details or go to the marketplace and filter by installed apps.


Did this page help you?