diff --git a/README.md b/README.md index 55a4b5d5da..97311b1f4d 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ The Backstage platform consists of a number of different components: - **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/create-an-app.md). - [**plugins**](https://github.com/spotify/backstage/tree/master/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. +- [**backend**](https://github.com/spotify/backstage/tree/master/packages/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. diff --git a/packages/backend/README.md b/packages/backend/README.md new file mode 100644 index 0000000000..1246be60bc --- /dev/null +++ b/packages/backend/README.md @@ -0,0 +1,20 @@ +# example-backend + +This package is an EXAMPLE of a Backstage backend. + +The main purpose of this package is to provide a test bed for Backstage plugins +that have a backend part. Feel free to experiment locally or within your fork +by adding dependencies and routes to this backend, to try things out. + +Our goal is to eventually amend the create-app flow of the CLI, such that a +production ready version of a backend skeleton is made alongside the frontend +app. Until then, feel free to experiment here! + +## Development + +To run the backend in watch mode, use `yarn start`. + +## Documentation + +- [Backstage Readme](https://github.com/spotify/backstage/blob/master/README.md) +- [Backstage Documentation](https://github.com/spotify/backstage/blob/master/docs/README.md) diff --git a/packages/backend/src/index.ts b/packages/backend/src/index.ts index 17c606c037..307bd04be7 100644 --- a/packages/backend/src/index.ts +++ b/packages/backend/src/index.ts @@ -14,12 +14,20 @@ * limitations under the License. */ +/* + * Hi! + * + * Note that this is an EXAMPLE Backstage backend. Please check the README. + * + * Happy hacking! + */ + import express from 'express'; import cors from 'cors'; import helmet from 'helmet'; import { testRouter } from './test'; -const PORT = 7000; +const PORT = parseInt(process.env.PORT ?? '', 10) || 7000; const app = express(); app.use(helmet());