CNCF Atlas

English

日本語

English

日本語

Appearance

Getting Started ​

Verified against version 1.53.0-next.0 (pinned commit bccd96d). Commands assume a Unix-like shell.

This creates a standalone Backstage app from the official scaffolder, not a clone of the monorepo. The monorepo is for developing Backstage itself; adopters generate their own app.

Prerequisites ​

  • Node.js. The monorepo's root package.json declares engines.node of 22 || 24, so use Node 22 or 24.
  • Yarn. The repo pins Yarn 4.4.1; the generated app uses Yarn as well.
  • A C compiler toolchain for native modules, and Git.

Install ​

The app is generated by a one-off command, so there is nothing to install globally first.

bash
npx @backstage/create-app@latest

A first working setup ​

  1. Run the create-app command and answer the prompt for an app name. It scaffolds a new directory containing the frontend (packages/app) and backend (packages/backend).

    bash
    npx @backstage/create-app@latest

  2. Enter the generated directory and start both the frontend and backend together.

    bash
    cd my-backstage-app
yarn start

  3. The frontend serves on port 3000 and the backend on port 7007. Open the app in a browser at http://localhost:3000.

By default the app uses an in-memory SQLite database, so it runs with no external services. The example catalog entities shipped in the template appear in the Catalog page immediately.

Verify it works ​

Confirm the backend is up by hitting its catalog endpoint and checking that entities are returned.

bash
curl http://localhost:7007/api/catalog/entities

A healthy backend returns a JSON array of entities (the seeded example components, the guest user, and so on). In the browser, the Catalog page at http://localhost:3000/catalog should list those same entities.

Where to go next ​

For production concerns, follow the official docs rather than the create-app defaults: switch the database to PostgreSQL, configure an auth provider in place of the guest provider, and set up TechDocs storage. See the Backstage documentation for deployment, the backend system, and plugin development.