Merge branch 'main' into MCA-201-getServerSideProps-error

Author: willgibson-madetech

.envrc.example

@@ -0,0 +1,4 @@
+export MICROSOFT_GRAPH_CLIENT_ID="<from_1Password>"
+export MICROSOFT_GRAPH_CLIENT_SECRET="<from_1Password>"
+export MICROSOFT_GRAPH_B2C_TENANT_ID="<from_1Password>"
+export MICROSOFT_GRAPH_B2C_TENANT_NAME="<from_1Password>"

.tool-versions

@@ -2,3 +2,6 @@
 
 java adoptopenjdk-17.0.15+6
 nodejs 20.19.1
+# Todo: This is the first version that supports macOS + arm. Aside from it obviously being a bit behind the times, we should update the pipelines to match.
+# https://madetech-team-b91dpvs1.atlassian.net/browse/MCA-228
+terraform 1.1.0

Makefile

@@ -5,30 +5,47 @@
 #
 ###
 
-# Run jobs in parallel so we can see log output
 MAKEFLAGS += -j
 
 .PHONY: setup
 setup: setup-root setup-backoffice setup-webapp
+	asdf plugin add nodejs
 
 .PHONY: setup-root
 setup-root:
-	@echo "⏭ Installing root level dependencies and commit hooks..."
-	@cd ./ && npm install
+	@echo "\n==================================================="
+	@echo "Installing root level dependencies and commit hooks\n"
+	cd . && \
+		asdf install && \
+		node --version && \
+		npm install
 
 .PHONY: setup-backoffice
 setup-backoffice:
-	@echo "⏭ Installing backoffice dependencies..."
-	@cd ./backoffice && npm install
+	@echo "\n=================================="
+	@echo "Installing backoffice dependencies\n"
+	cd ./backoffice && \
+		asdf install && \
+		node --version && \
+		npm install
 
 .PHONY: setup-webapp
 setup-webapp:
-	@echo "⏭ Installing webapp dependencies..."
-	@cd ./webapp && npm install
+	@echo "\n=============================="
+	@echo "Installing webapp dependencies\n"
+	cd ./webapp && \
+		asdf install && \
+		node --version && \
+		npm install
 
 ##
 # Applications
 ##
+
+# We are using --jobs so that all jobs run in parallel
+# Without this flag, the first job hogs the terminal and the others don't run
+MAKEFLAGS += --jobs
+
 .PHONY: serve
 serve: serve-backing-services serve-webapp serve-backoffice serve-backoffice-stubs
 

README.md

@@ -41,21 +41,23 @@ unsure.
 
 Before you start...
 
-- Make sure you have the required versions of things installed. We recommend using [asdf](asdf-vm.com) to manage this. See the `.tool-versions` if you want to manage them some other way.
-- Copy `webapp/.env.example` as `webapp/.env.local` and populate it with the contents of the "Beacons Webapp Local .env.local config" secure note in 1Password.
-- Export all environment variables from "Microsoft Graph Secrets - TEST" from 1Password to your terminal.
-- ```bash
-  $ export MICROSOFT_GRAPH_CLIENT_ID="changeme"
-  $ export MICROSOFT_GRAPH_CLIENT_SECRET="changeme"
-  $ export MICROSOFT_GRAPH_B2C_TENANT_ID="changeme"
-  $ export MICROSOFT_GRAPH_B2C_TENANT_NAME="changeme"
-  ```
-- ```bash
-  $ make setup # Install all the things, setup commit hooks etc.
-  ```
-- ```bash
-  $ make serve # Start up the applications in development mode, with backing services
-  ```
+- Make sure you have the required versions of things installed.
+  - Install [asdf](asdf-vm.com), or 'brew install asdf' which will automatically manage this.
+  - See the `.tool-versions` if you want to manage them some other way.
+- Copy `webapp/.env.example` as `webapp/.env.local` and populate it with the contents of the "Beacons Webapp Local .env.local config" secure note in 1Password. Please ensure you click "Edit" in 1Password before copying the config.
+- Get the Microsoft Graph secrets into your environment variables from "Microsoft Graph Secrets - TEST" from 1Password to your terminal.
+  - We recommend using [direnv](https://direnv.net/) to manage this.
+  - Save the `.envrc.example` file in the root of the repository as `.envrc` and populate the values with what's in "Microsoft Graph Secrets - TEST" in 1Password
+- Install all the things, setup commit hooks etc.
+  - ```bash
+    # From the root of this repository
+    make setup
+    ```
+- Start up the applications in development mode, with backing services
+  - ```bash
+    # From the root of this repository
+    make serve
+    ```
 
 ## Infrastructure-as-code
 

backoffice/.tool-versions

@@ -0,0 +1 @@
+nodejs 24.11.1

backoffice/README.md

@@ -1,8 +1,10 @@
 # beacons-backoffice
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+## Local development
 
-## Available Scripts
+Follow [the instructions in the root README to get started](../README.md#local-development).
+
+## Working on the Backoffice in isolation
 
 In the Backoffice SPA sub-directory, you can run: