Backstage (backstage-boeing)

A Boeing-themed Backstage app scaffolded from the Backstage template. This repository contains the monorepo for the Backstage frontend app, backend, plugins, and example content to help you run and extend a corporate developer portal.

This README replaces the minimal scaffold README and provides practical instructions for contributors and maintainers working with this project.

Table of Contents

• Features
• Quick Start
• Development
• Project layout
• Configuration
• Deployment
• Contributing
• License

Features

• Full Backstage monorepo: app frontend, backend, and plugins
• Boeing-themed UI (custom theme and logos)
• Example catalog entities and templates to bootstrap components and services
• Kubernetes deployment manifests and Dockerfile for containerized runs

Quick Start

Prerequisites:

• Node.js 18+ and npm or Yarn (this project uses Yarn v4 via the included release)
• Docker (optional, for building images)
• kubectl (optional, for deploying to Kubernetes)

Install dependencies and start the development server:

# Install dependencies (yarn is recommended because the repo includes a yarn release)
yarn install

# Start the Backstage app (frontend + backend in dev mode)
yarn start

Open http://localhost:3000 in your browser. The backend runs on http://localhost:7007 by default.

Development

• Frontend app code lives in packages/app
• Backend service code lives in packages/backend
• Reusable packages, plugins and shared code live under packages/ and plugins/

Common commands (run from the repo root):

# Install dependencies
yarn install

# Start dev server (frontend + backend)
yarn start

# Run backend only
yarn workspace @backstage/backend start

# Run frontend only
yarn workspace @backstage/app start

# Run unit tests
yarn test

# Run e2e tests (Playwright configured)
yarn playwright test

Adjust the workspace/package names above to match actual package.json "name" fields as needed.

Project layout (important paths)

• packages/app — Backstage frontend application
• packages/backend — Backstage backend service
• plugins/ — Backstage plugins and custom extensions
• examples/ — Example entities, templates and content
• kubernetes/ — Deployment YAML for Kubernetes

Configuration

Configuration is primarily driven by app-config.yaml and environment variables.

• app-config.yaml — default runtime configuration
• app-config.production.yaml — production overrides

Common environment variables:

• APP_CONFIG_PRESETS — path or env overrides for Backstage
• DATABASE_CLIENT_URL — backend database connection string (if used)
• PORT — backend port (defaults are set in packages/backend)

See the Backstage documentation for full configuration details: https://backstage.io/docs

Building & Deployment

A simple Docker image and Kubernetes manifests are included under packages/backend/Dockerfile and kubernetes/backstage.

Build image (example):

yarn -s workspace @backstage/backend build
docker build -f packages/backend/Dockerfile -t your-registry/backstage:latest .

Deploy to Kubernetes (example):

kubectl apply -f kubernetes/backstage/

Adjust manifests for your cluster, ingress, and secrets management as required.

Contributing

Contributions are welcome.

Suggested workflow:

1. Fork the repository
2. Create a feature branch (feat/..., fix/...)
3. Run tests and linting locally
4. Open a Pull Request with a clear description and any relevant screenshots

Please follow existing code style and include tests for new features.

License

Specify your project license here (e.g., MIT). Add a LICENSE file at the repo root.

Acknowledgements

Based on the Backstage OSS project: https://backstage.io