docs: overhaul README and remove TEMPLATE_STATUS#69
Merged
Conversation
README updates: - Prerequisites: Go 1.25+, Node.js 22+ (were 1.21/20) - Installation: reference .env.example (not .env.local) - Added quick-start via setup.sh/dev.sh - Project structure updated to match actual clean-architecture layout - Environment variables: expanded table, link to RUNBOOK.md for full list - Dev commands: added make lint, swagger, all migrate-* targets, Spotless - Added ADR and RUNBOOK links in Contributing section - Tech stack: accurate versions, Firebase Auth, Redis/Asynq, correct test tooling TEMPLATE_STATUS.md removed — all 21 issues resolved and merged.
📝 WalkthroughWalkthroughREADME.md was reorganized and expanded across overview, setup, reference, command, testing, and contribution sections. TEMPLATE_STATUS.md was removed. ChangesREADME refresh
Template status cleanup
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
ANDROID_HOME is often not set as an explicit env var even when Android Studio is installed — the SDK lives at the predictable path %LOCALAPPDATA%\Android\Sdk. Fall back to that location before failing, and surface a one-liner to set the variable permanently for users who want full tooling compatibility.
Child powershell processes inherit the Restricted execution policy, which blocks pnpm.ps1 and other npm-installed script wrappers. Bypass applies only to those child windows and does not change the machine or user policy.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
.env.examplereferences, updates project structure to match actual clean-architecture layout, expands env var table with link to RUNBOOK.md, adds allmake lint/swagger/migrate-*commands, Spotless Gradle targets, quick-start viasetup.sh/dev.sh, and links to ADRs and RUNBOOK in the Contributing sectionTEMPLATE_STATUS.md— all 21 readiness gaps (fix(backend): make CORS origin a config value instead of hardcoded localhost:3000 #44–docs(infra): add deployment runbook for staging and production #64) are resolved and merged; the file served its purposesetup.ps1— Android SDK detection — script now falls back to%LOCALAPPDATA%\Android\SdkwhenANDROID_HOMEis not set as an explicit env var (Android Studio installs there by default but does not always set the variable); prints a one-liner to set it permanently if missingdev.ps1+setup.ps1— PowerShell execution policy — spawned child windows now receive-ExecutionPolicy Bypassso npm-installed script wrappers likepnpm.ps1run without aSecurityErroron machines withRestrictedpolicyNo backend or web code changes.