Skip to content

Setup docs#536

Open
chetanr25 wants to merge 3 commits into
fireform-core:developmentfrom
chetanr25:setup_docs
Open

Setup docs#536
chetanr25 wants to merge 3 commits into
fireform-core:developmentfrom
chetanr25:setup_docs

Conversation

@chetanr25

Copy link
Copy Markdown
Collaborator

Add setup and project structure docs

Two new docs under docs/, plus a cleanup of CONTRIBUTING.md.

docs/ 1. SETUP.md - beginner setup guide. Prerequisites, make init / make fireform walkthrough,
verifying via the Swagger UI at localhost:8000/docs, day-to-day make commands, and a troubleshooting
section for the usual failures (Docker not running, port 8000 taken, slow model pull). Also points to the
frontend repo since it lives separately now.

docs/ 2. PROJECT_STRUCTURE.md - explains how the repo is laid out and where new code should go. Covers
the layering inside app/ (routes → services → repositories → db) with concrete recipes: how to add an
endpoint, a table, an env var, a custom error. Should save reviewers from repeating the same "this
belongs in services" comments on every PR.

CONTRIBUTING.md changes:

  • Setup instructions were duplicated between CONTRIBUTING and the new guide, so the Local Development
    Setup section is now just a link to it. The old desktop app section referenced fireform-frontend, which
    doesn't exist in this repo anymore removed.
  • Added the Discord invite and a note on how issues work here: we don't formally assign them, anyone is
    free to pick one up and raise a PR. First PR that actually fixes the issue generally gets preference, so
    coordinate on Discord to avoid duplicate work.

Fixes: #519
Part of #512

@chetanr25 chetanr25 marked this pull request as ready for review June 11, 2026 21:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant