Suzanne Daniels
4.3 KiB
id, title, description
| id | title | description |
|---|---|---|
| index | Getting Started | Documentation on How to get started with Backstage |
For most Backstage installations, installing the standalone app will bring you the best and most streamlined experience. In this guide you will:
- Deploy Backstage Standalone with npm packages
- Run Backstage Standalone with a SQLite in-memory database and demo content
This guide assumes a basic understanding of working on a Linux based operating system using tools like apt-get, npm, yarn, curl. Docker knowledge is also helpful for making the best use of your Backstage installation.
If you are planning to contribute plugins or the project in general, we advise you to use the Getting Started for Contributers guide to do a repository-based installation.
Prerequisites
- Access to a linux based operating system
- An account with elevated rights (eg. via sudo)
curlorwgetinstalled- Node.js Active LTS Release installed (currently v14) using one of these methods:
- Using
nvm(recommended) - Binary Download
- Package manager
- Using NodeSource packages
- Using
yarnInstallationdockerinstallationgitinstallation- If the system is not directly accessible over your network, the following ports need to be opened: 3000, 7000
Create your Backstage App
To install the Backstage Standalone app, we make use of npx, a tool to run Node executables
straight from the registry. Running the command below will install Backstage. The wizard will
create a subdirectory inside your current working directory.
npx @backstage/create-app
The wizard will ask you
- The name of the app, which will also be the name of the directory
- The database type to use for the backend. For this guide, you'll be using the SQLite option.
Run the Backstage app
When the installation is complete you can go to the application directory and start the app. The yarn dev command will run both the frontend and backend as separate processes (named [0] and [1]) in the same window.
cd my-backstage-app
yarn dev
It might take a little while, but as soon as the message [0] webpack compiled successfully appears, you can open a browser and directly navigate to
your freshly installed Backstage portal at http://localhost:3000. You can start exploring the demo immediately.
Congratulations! That should be it. Let us know how it went: on discord, file issues for any feature or plugin suggestions, or bugs you have, and feel free to contribute!
The most common next steps are to configure Backstage, add a plugin and moving to a more persistend database: