From 71a597059b0c2c1716cc2a4458322a176b9ba041 Mon Sep 17 00:00:00 2001
From: Max Wofford <max@maxwofford.com>
Date: Fri, 7 Mar 2025 18:13:04 -0500
Subject: [PATCH] Start working on new README setup steps

---
 .env.example |  7 +++++--
 README.md    | 27 +++++++++++++--------------
 2 files changed, 18 insertions(+), 16 deletions(-)

diff --git a/.env.example b/.env.example
index 1ce3fe6..aa75300 100644
--- a/.env.example
+++ b/.env.example
@@ -1,20 +1,23 @@
 # Example environment variables
-PORT=4000
 
+# Slack oauth used for slack signin + profile status feature
 SLACK_CLIENT_ID=your_client_id_here
 SLACK_CLIENT_SECRET=your_client_secret_here
 SLACK_SIGNING_SECRET=your_signing_secret_here
 SLACK_USER_OAUTH_TOKEN=your_user_oauth_token_here
 
-# Sailors' log slack app
+# Sailors' log slack app for slack channel notifications
 SLACK_SAILORS_LOG_SIGNING_SECRET=your_signing_secret_here
 SLACK_SAILORS_LOG_BOT_OAUTH_TOKEN=your_bot_oauth_token_here
 TELETYPE_API_KEY=your_teletype_api_key_here
 
+# Wakatime database url used for migrating data from waka.hackclub.com
 WAKATIME_DATABASE_URL=your_wakatime_database_url_here
 
+# You can leave this alone if you're using the provided docker setup!
 DATABASE_URL=your_database_url_here
 
+# Secret key base
 SECRET_KEY_BASE=your_secret_key_base_here
 
 ENCRYPTION_PRIMARY_KEY=generate_a_key_and_put_it_here
diff --git a/README.md b/README.md
index 7db80e4..b89ec8a 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,23 @@
 # README
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
+## Local development
 
-Things you may want to cover:
+```sh
+# Set it up...
+git clone https://github.com/hackclub/harbor && cd harbor
 
-* Ruby version
+# Set your config
+cp .env.example .env
 
-* System dependencies
+# THIS IS THE PART WHERE YOU EDIT YOUR CONFIG
+vim .env
 
-* Configuration
+# need your local db to be encrypted for some reason? Sure! Replace all the
+# secrets with the output of this:
+bin/rails runner "puts SecureRandom.base64"
+# not guaranteed to be secure for production, but fine for local development
 
-* Database creation
 
-* Database initialization
+# Build the project
 
-* How to run the test suite
 
-* Services (job queues, cache servers, search engines, etc.)
-
-* Deployment instructions
-
-* ...