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

backend,proto: remove

Browse Source
This commit is contained in:
Patrik Oldsberg
2020-03-09 16:25:19 +01:00
parent 93924f1751
commit bbff5aaa1a
154 changed files with 5 additions and 7248 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -19
View File
@@ -17,13 +17,13 @@ At Spotify we [strongly believe](https://backstage.io/the-spotify-story) that a
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_.
- **frontend** - Main web application that users interact with. It's built up by a number of different _Plugins_.
- **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.
- **identity** * - A backend service that holds your organisation's metadata.
- **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.
- **identity** \* - A backend service that holds your organisation's metadata.
_* not yet released_
_\* not yet released_
![overview](backstage_overview.png)
@@ -63,20 +63,6 @@ This will prompt you to enter an ID for your plugin, and then create your plugin
If you have `yarn start` already running you should be able to see the default page for your new plugin at [localhost:3000/my-plugin](http://localhost:3000/my-plugin), if you called the plugin `"my-plugin"`.
## Running the backend(s) locally
For running the backend, depending on your OS, you need [Docker Desktop for Mac](https://docs.docker.com/docker-for-mac/install/), [Docker Desktop for Windows](https://docs.docker.com/docker-for-windows/install/), or for Linux, [docker](https://docs.docker.com/install/) and [docker-compose](https://docs.docker.com/compose/install/#install-compose-on-linux-systems).
The full local system consists of a collection of backend services, as well as a web application. From the root of the project directory, run the following in a terminal to start up all backend services locally:
```bash
$ cd backend
$ docker-compose up --build
```
To develop backend services, there are some more tools to install, see [backend/README.md](backend/README.md). To update protobuf definitions, you will need another set of tools, see [proto/README.md](proto/README.md).
## Documentation
_TODO: Add links to docs on backstage.io_