Setup docs#536
Open
chetanr25 wants to merge 3 commits into
Open
Conversation
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.
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 fireformwalkthrough,verifying via the Swagger UI at
localhost:8000/docs, day-to-day make commands, and a troubleshootingsection 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 anendpoint, 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 section is now just a link to it. The old desktop app section referenced
fireform-frontend, whichdoesn't exist in this repo anymore removed.
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