update docs to match new build script + fixes

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-11-15 11:04:19 +01:00
parent 657b0da3c7
commit 5e7bdb0109
15 changed files with 36 additions and 61 deletions
@@ -54,8 +54,8 @@
      You can add webfonts, meta tags, or analytics to this file.
      The build step will place the bundled scripts into the <body> tag.

-      To begin the development, run `npm start` or `yarn start`.
-      To create a production bundle, use `npm run build` or `yarn build`.
+      To begin the development, run `yarn start`.
+      To create a production bundle, use `yarn build`.
    -->
  </body>
 </html>
@@ -5,7 +5,7 @@
 #
 # yarn install
 # yarn tsc
-# yarn build
+# yarn build:backend
 #
 # Once the commands have been run, you can build the image using `yarn build-image`

@@ -16,8 +16,6 @@ To run the example backend, first go to the project root and run

 ```bash
 yarn install
-yarn tsc
-yarn build
 ```

 You should only need to do this once.
@@ -25,16 +23,11 @@ You should only need to do this once.
 After that, go to the `packages/backend` directory and run

 ```bash
-AUTH_GOOGLE_CLIENT_ID=x AUTH_GOOGLE_CLIENT_SECRET=x \
-AUTH_GITHUB_CLIENT_ID=x AUTH_GITHUB_CLIENT_SECRET=x \
-AUTH_OAUTH2_CLIENT_ID=x AUTH_OAUTH2_CLIENT_SECRET=x \
-AUTH_OAUTH2_AUTH_URL=x AUTH_OAUTH2_TOKEN_URL=x \
-LOG_LEVEL=debug \
 yarn start
 ```

-Substitute `x` for actual values, or leave them as dummy values just to try out
-the backend without using the auth or sentry features.
+If you want to override any configuration locally, for example adding any secrets,
+you can do so in `app-config.local.yaml`.

 The backend starts up on port 7007 per default.