Skip to content

Backstage Fundamentals

Welcome to the Backstage Fundamentals section! This hands-on guide will help you get started with Backstage quickly and efficiently. By the end of this guide, you'll have a working Backstage instance with a sample repository in the catalog and documentation powered by TechDocs.

What You'll Learn

In this practical guide, you'll learn how to:

  • Install and run a vanilla Backstage instance
  • Add a repository to the Software Catalog
  • Create and view documentation using TechDocs
  • Configure GitHub integration for real-world usage

Prerequisites

Before you begin, make sure you have:

  • Node.js (version 18 or later)
  • Yarn
  • Git
  • A GitHub account (for the GitHub integration part)

How to Use This Guide

This guide is designed to be followed sequentially, with each section building on the previous one. You can copy and paste the commands directly into your terminal to follow along. The exercises are designed to be completed in about 30-60 minutes.

Let's get started by setting up your Backstage instance!