diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index 12662ddfeb..7df10f8bb6 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -4,8 +4,8 @@ title: Getting Started description: 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: +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 @@ -15,15 +15,17 @@ 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 Contributors](https://backstage.io/docs/getting-started/running-backstage-locally) guide to -do a repository-based installation. +you to use the +[Getting Started for Contributors](https://backstage.io/docs/getting-started/running-backstage-locally) +guide to do a repository-based installation. ### Prerequisites -- Access to a linux based operating system -- An account with elevated rights (eg. via sudo) +- Access to a Linux based operating system +- An account with elevated rights - `curl` or `wget` installed -- Node.js Active LTS Release installed (currently v14) using one of these methods: +- Node.js Active LTS Release installed (currently v14) using one of these + methods: - Using `nvm` (recommended) - [Installing nvm](https://github.com/nvm-sh/nvm#install--update-script) - [Install and change Node version with nvm](https://nodejs.org/en/download/package-manager/#nvm) @@ -38,9 +40,10 @@ do a repository-based installation. ### 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. +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. ```bash npx @backstage/create-app @@ -49,7 +52,8 @@ 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. +- The database type to use for the backend. For this guide, you'll be using the + SQLite option.

Screenshot of the wizard asking for a name for the app, and a selection menu for the database. @@ -57,7 +61,9 @@ The wizard will ask you ### 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. +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. ```bash cd my-backstage-app @@ -65,14 +71,16 @@ yarn dev ```

- Screenshot of the command output, with the message webpack compiled successfully. + Screenshot of the command output, with the message web pack compiled successfully.

-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. +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.

- Screenshot of the Backstage portal homescreen. + Screenshot of the Backstage portal.

Congratulations! That should be it. Let us know how it went: @@ -80,10 +88,13 @@ Congratulations! That should be it. Let us know how it went: [feature](https://github.com/backstage/backstage/issues/new?labels=help+wanted&template=feature_template.md) or [plugin suggestions](https://github.com/backstage/backstage/issues/new?labels=plugin&template=plugin_template.md&title=%5BPlugin%5D+THE+PLUGIN+NAME), -or [bugs](https://github.com/backstage/backstage/issues/new?labels=bug&template=bug_template.md) -you have, and feel free to [contribute](https://github.com/backstage/backstage/blob/master/CONTRIBUTING.md)! +or +[bugs](https://github.com/backstage/backstage/issues/new?labels=bug&template=bug_template.md) +you have, and feel free to +[contribute](https://github.com/backstage/backstage/blob/master/CONTRIBUTING.md)! -The most common next steps are to configure Backstage, add a plugin and moving to a more persistend database: +The most common next steps are to configure Backstage, add a plugin and moving +to a more persistent database: - [Setting up Authentication](https://github.com/backstage/backstage/tree/master/plugins/auth-backend#github) - [Switching from SQLite to PostgresQL](https://backstage.io/docs/tutorials/switching-sqlite-postgres)