From 4754ed857f91d169cb5d4620092606962824f777 Mon Sep 17 00:00:00 2001
From: Daniel Wagner-Hall <dawagner@gmail.com>
Date: Wed, 11 Mar 2026 14:50:32 +0000
Subject: [PATCH 1/2] Add README

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e212872
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# trainee-tracker
+
+A website for tracking trainee progress, which also contains a grab-bag of tools which re-use code and auth.
+
+We hope to replace all of this functionality with a well built system, but for now, it glues together different data sources conveniently.
+
+## Local development
+
+To develop locally, you need a few pieces, which you can configure in a `.env` file:
+
+### Local config
+
+You probably want to set exactly this: `CYF_TRAINEE_TRACKER_PUBLIC_BASE_URL=http://localhost:3000`
+
+### GitHub OAuth app
+
+Set up an OAuth application in https://github.com/settings/developers and set the following env vars:
+
+* `CYF_TRAINEE_TRACKER_GITHUB_CLIENT_ID`
+* `CYF_TRAINEE_TRACKER_GITHUB_CLIENT_SECRET`
+
+### Google OAuth app
+
+Set up an OAuth application in a project in https://console.cloud.google.com/auth/clients/create and set the following env vars:
+
+* `CYF_TRAINEE_TRACKER_GOOGLE_APIS_CLIENT_ID`
+* `CYF_TRAINEE_TRACKER_GOOGLE_APIS_CLIENT_SECRET`
+
+### Slack (optional)
+
+If you want Slack integration (you probably don't), make a Slack App and set `CYF_TRAINEE_TRACKER_SLACK_CLIENT_SECRET=`.

From 5f5cc98ce08652ee6db0e03dd85f52bb246dbaa1 Mon Sep 17 00:00:00 2001
From: Daniel Wagner-Hall <daniel@codeyourfuture.io>
Date: Wed, 11 Mar 2026 15:04:14 +0000
Subject: [PATCH 2/2] Update README.md

Co-authored-by: LonMcGregor <3817332+LonMcGregor@users.noreply.github.com>
---
 README.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/README.md b/README.md
index e212872..6d800db 100644
--- a/README.md
+++ b/README.md
@@ -29,3 +29,7 @@ Set up an OAuth application in a project in https://console.cloud.google.com/aut
 ### Slack (optional)
 
 If you want Slack integration (you probably don't), make a Slack App and set `CYF_TRAINEE_TRACKER_SLACK_CLIENT_SECRET=`.
+
+### PR validator bot (optional)
+To allow the PR validator to test things without setting up a github app for the whole tracker, create a token with with pull request permissions and set the following env var:
+* `GH_TOKEN=`