Update README.md#64
Conversation
Readme updated with steps to run local development
📝 WalkthroughWalkthroughThe README replaces the previous local setup checklist with detailed instructions for registry authentication, Compose startup, OSM migrations, workspace database creation, PostGIS enablement, and restarting the development stack. ChangesLocal development setup
Estimated code review effort: 1 (Trivial) | ~3 minutes Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 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}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 98: Remove the trailing space inside the inline code span containing the
docker login command, while preserving the command text and formatting.
- Around line 124-130: Update the README database setup commands so the first
psql session is terminated with the psql quit command \q, or split the database
creation and connection steps into separate psql invocations; remove the invalid
exit; SQL command while preserving the existing database and PostGIS setup
sequence.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
|
|
||
| Docker login command: | ||
|
|
||
| `docker login opensidewalksdev.azurecr.io -u opensidewalksdev ` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Remove the trailing space inside the code span.
This triggers markdownlint MD038.
-`docker login opensidewalksdev.azurecr.io -u opensidewalksdev `
+`docker login opensidewalksdev.azurecr.io -u opensidewalksdev`📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| `docker login opensidewalksdev.azurecr.io -u opensidewalksdev ` | |
| `docker login opensidewalksdev.azurecr.io -u opensidewalksdev` |
🧰 Tools
🪛 markdownlint-cli2 (0.23.0)
[warning] 98-98: Spaces inside code span elements
(MD038, no-space-in-code)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 98, Remove the trailing space inside the inline code span
containing the docker login command, while preserving the command text and
formatting.
Source: Linters/SAST tools
| ```shell | ||
| psql --username postgres | ||
| create database "workspaces-tasks-local"; | ||
| exit; | ||
| psql --username postgres --dbname "workspaces-tasks-local"; | ||
| create extension if not exists postgis; | ||
|
|
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
docker compose --file docker-compose.local.yml exec database \
psql --username postgres --dbname workspaces-tasks-local \
--command "SELECT current_database(), EXISTS (SELECT 1 FROM pg_extension WHERE extname = 'postgis');"Repository: TaskarCenterAtUW/workspaces-backend
Length of output: 217
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf '\nREADME excerpt around the claimed lines:\n'
sed -n '118,134p' README.md | cat -n
printf '\nSearch for psql/exit usage in README:\n'
rg -n 'psql|exit;|\\q|CREATE EXTENSION|CREATE DATABASE' README.md
printf '\nIf available, inspect psql help text locally:\n'
command -v psql >/dev/null 2>&1 && psql --help | sed -n '1,80p' || echo 'psql binary not available'Repository: TaskarCenterAtUW/workspaces-backend
Length of output: 966
Use \q or separate psql commands here.
exit; is SQL, not a psql quit command, so this block does not leave the first session before the next command.
Proposed fix
-psql --username postgres
-create database "workspaces-tasks-local";
-exit;
-psql --username postgres --dbname "workspaces-tasks-local";
-create extension if not exists postgis;
+psql --username postgres --command 'CREATE DATABASE "workspaces-tasks-local";'
+psql --username postgres --dbname "workspaces-tasks-local" \
+ --command 'CREATE EXTENSION IF NOT EXISTS postgis;'📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ```shell | |
| psql --username postgres | |
| create database "workspaces-tasks-local"; | |
| exit; | |
| psql --username postgres --dbname "workspaces-tasks-local"; | |
| create extension if not exists postgis; |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 124 - 130, Update the README database setup commands
so the first psql session is terminated with the psql quit command \q, or split
the database creation and connection steps into separate psql invocations;
remove the invalid exit; SQL command while preserving the existing database and
PostGIS setup sequence.
3 participants
Readme updated with steps to run local development
Summary
Updated
README.mdwith detailed local development setup instructions, including:workspaces-tasks-localdatabase and PostGIS extension setupdocker compose downandup --build