From d8f28dc94e4dd6608818c69607fa1f1e6daaf415 Mon Sep 17 00:00:00 2001 From: Bilawal Hameed Date: Fri, 7 Feb 2020 11:45:15 +0100 Subject: [PATCH 1/2] Add a secrets.env.example --- secrets.env.example | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 secrets.env.example diff --git a/secrets.env.example b/secrets.env.example new file mode 100644 index 0000000000..c83bd2158b --- /dev/null +++ b/secrets.env.example @@ -0,0 +1,4 @@ +NODE_ENV=development +NODE_DEBUG=true +REACT_APP_GRAPHQL_API="" +BOSS_GH_ACCESS_TOKEN="" From cd9ae767001e890fc6826678f4ba0f2f66fa1b86 Mon Sep 17 00:00:00 2001 From: Bilawal Hameed Date: Fri, 7 Feb 2020 11:46:07 +0100 Subject: [PATCH 2/2] Added docs --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 7a8c78ecf4..c1001481df 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,14 @@ Backstage is an open platform for building developer portals. ## Getting started +### Secrets + +To setup secrets, copy the `secrets.env.example` to `secrets.env` as such: + +```bash +$ cp secrets.env.example secrets.env +``` + ### Protobuf Definitions To generate the Protobuf definitions in Go and TypeScript, run the following command from the root with [Prototool](https://github.com/uber/prototool):