Clarify creating a new plugin as the next step (#575)

* Move create-app docs out from getting started

* Add contributing to readme.md
This commit is contained in:
Marcus Eide
2020-04-17 11:44:36 +02:00
committed by GitHub
parent eb76a4d05a
commit 23802d6c58
5 changed files with 19 additions and 14 deletions
+3 -2
View File
@@ -1,9 +1,10 @@
# Getting started with Backstage
Here is a collection of tutorials that will guide you through setting up and extending an instance of Backstage with your own plugins.
## Creating a Plugin
The value of Backstage grows with every new plugin that gets added. Here is a collection of tutorials that will guide you through setting up and extending an instance of Backstage with your own plugins.
- [Development Environment](development-environment.md)
- [Create a Backstage App](create-an-app.md)
- [Create a Backstage plugin](create-a-plugin.md)
- [Structure of a plugin](structure-of-a-plugin.md)
- Using Backstage components (TODO)
-76
View File
@@ -1,76 +0,0 @@
# Backstage App
To get set up quickly with your own Backstage project you can create a Backstage App.
A Backstage App is a monorepo setup with `lerna` that includes everything you need to run Backstage in your own environment.
## Create an app
To create a Backstage app, you will need to have [NodeJS](https://nodejs.org/en/download/) Active LTS Release installed (currently v12).
With `npx`:
```bash
npx @backstage/cli create-app
```
This will create a new Backstage App inside the current folder. The name of the app-folder is the name that was provided when prompted.
<p align='center'>
<img src='https://github.com/spotify/backstage/raw/master/docs/getting-started/create-app_output.png' width='600' alt='create app'>
</p>
Inside that directory, it will generate all the files and folder structure needed for you to run your app.
### Folder structure
```
app
├── README.md
├── lerna.json
├── package.json
├── prettier.config.js
├── tsconfig.json
├── packages
│ └── app
│ ├── package.json
│ ├── tsconfig.json
│ ├── public
│ │ └── ...
│ └── src
│ ├── App.test.tsx
│ ├── App.tsx
│ ├── index.tsx
│ ├── plugins.ts
│ └── setupTests.ts
└── plugins
└── welcome
├── README.md
├── package.json
├── tsconfig.json
└── src
├── index.ts
├── plugin.test.ts
├── plugin.ts
├── setupTests.ts
└── components
├── Timer
│ └── ...
└── WelcomePage
└── ...
```
## Run the app
When the installation is complete you can open the app folder and start the app.
```bash
cd my-backstage-app
yarn start
```
_When `yarn start` is ready it should open up a browser window displaying your app, if not you can navigate to `http://localhost:3000`._
[Next Step - Create a Backstage plugin](create-a-plugin.md)
[Back to Docs](README.md)
Binary file not shown.

Before

Width:  |  Height:  |  Size: 303 KiB

@@ -34,4 +34,6 @@ Then open http://localhost/ on your browser.
> See [package.json](/package.json) for other yarn commands/options.
[Next Step - Create a Backstage plugin](create-a-plugin.md)
[Back to Docs](README.md)