docs(local-setup): add backend, admin app, and client SDK dev guide - #1814
Open
Shreyag02 wants to merge 1 commit into
Open
docs(local-setup): add backend, admin app, and client SDK dev guide#1814Shreyag02 wants to merge 1 commit into
Shreyag02 wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📝 WalkthroughSummary by CodeRabbit
WalkthroughChangesLocal setup guide
Estimated code review effort: 2 (Simple) | ~10 minutes 🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 92712be4-c807-4c90-b859-34928513334a
📒 Files selected for processing (1)
docs/content/docs/local-setup.mdx
Comment on lines
+47
to
+49
| - `docker ps` — `frontier-pg-1`, `frontier-pg2-1`, `frontier-spicedb-1` all `(healthy)`. | ||
| - `lsof -nP -iTCP:8002 -sTCP:LISTEN` — backend listening. | ||
| - `docker exec frontier-pg-1 psql -U frontier -d frontier -c '\dt' | head` — app tables exist. |
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Avoid hard-coded Compose container names.
The guide permits a different clone location, but frontier-pg-1 is derived from the Compose project name and can differ by checkout directory or Compose version. Query services through the same Compose project instead.
Proposed fix
- `docker ps` — `frontier-pg-1`, `frontier-pg2-1`, `frontier-spicedb-1` all `(healthy)`.
+ `cd frontier && docker-compose -f docker-compose.yml ps` — `pg`, `pg2`, and `spicedb` should be healthy.
- `lsof -nP -iTCP:8002 -sTCP:LISTEN` — backend listening.
- `docker exec frontier-pg-1 psql -U frontier -d frontier -c '\dt' | head` — app tables exist.
+ `cd frontier && docker-compose -f docker-compose.yml exec -T pg psql -U frontier -d frontier -c '\dt' | head` — app tables exist.
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
1 participant
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.
Document local dev setup for the IAM Admin console frontend: running the backend and deps, the admin app, and the client SDK demo.