Skip to content

docs: add db init steps to README quick start#332

Open
level09 wants to merge 2 commits into
mainfrom
docs/readme-quickstart-db-init
Open

docs: add db init steps to README quick start#332
level09 wants to merge 2 commits into
mainfrom
docs/readme-quickstart-db-init

Conversation

@level09
Copy link
Copy Markdown
Collaborator

@level09 level09 commented May 7, 2026

The Quick Start section skips schema creation, so flask install exits with an error on a fresh clone (no Role table to query).

Add the two documented init steps between gen-env.sh and flask install:

  • flask create-db --create-exts creates the schema and PostGIS / pg_trgm extensions
  • flask db stamp head marks Alembic at the current revision so a later flask db upgrade is a no-op

flask install fails on a fresh clone because no User table exists.
Add flask create-db --create-exts and flask db stamp head between
gen-env.sh and flask install so the quick start actually works
end-to-end.
@level09 level09 requested a review from apodacaduron as a code owner May 7, 2026 17:39
@level09 level09 self-assigned this May 7, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 7, 2026

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: db6ab3f9-25e4-4520-b939-957f644b5339

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-quickstart-db-init

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@apodacaduron apodacaduron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we also add uv run flask db stamp head to docs/deployment/installation.md so the full install guide matches this Quick Start flow?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants