paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 34 Packages Projects Releases Wiki Activity

Merge pull request #457 from spotify/eide/docs-create-app

Browse Source 
Add documentation for how to create an app
This commit is contained in:
Marcus Eide
2020-04-06 08:58:17 +02:00
committed by GitHub
parent eed88be2ba f380f1bdf1
commit 86f02fe577
5 changed files with 93 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+4 -5
View File
@@ -41,7 +41,7 @@ Our vision for Backstage is for it to become the trusted standard toolbox (read:
The Backstage platform consists of a number of different components:
- **frontend** - Main web application that users interact with. It's built up by a number of different _Plugins_.
- **app** - Main web application that users interact with. It's built up by a number of different _Plugins_. This repo contains an example implementation of an app (located in `packages/example-app`) and you can easily get started with your own app by [creating one](docs/getting-started/create-an-app.md).
- **plugins** - Each plugin is treated as a self-contained web app and can include almost any type of content. Plugins all use a common set of platform API's and reusable UI components. Plugins can fetch data either from the _backend_ or through any RESTful API exposed through the _proxy_.
- **backend** \* - GraphQL aggregation service that holds the model of your software ecosystem, including organisational information and what team owns what software. The backend also has a Plugin model for extending its graph.
- **proxy** \* - Terminates HTTPS and exposes any RESTful API to Plugins.
@@ -53,7 +53,7 @@ _\* not yet released_
## Getting started
To run the Backstage frontend, you will need to have the following installed:
To run a Backstage app, you will need to have the following installed:
- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- [NodeJS](https://nodejs.org/en/download/) - Active LTS Release, currently v12
@@ -75,9 +75,8 @@ For more complex development environment configuration, see the
## Documentation
- [FAQs](docs/FAQ.md)
- [Create a Plugin](docs/getting-started/create-a-plugin.md)
- [Structure of a Plugin](docs/getting-started/structure-of-a-plugin.md)
- [Frontend architecture](docs/architecture-terminology.md)
- [Getting Started](docs/getting-started/README.md)
- [Architecture](docs/architecture-terminology.md)
- [API references](docs/reference/README.md)
- [Storybook - UI components](http://storybook.backstage.io) ([WIP](https://github.com/spotify/backstage/milestone/9))
- Using Backstage components (TODO)