docs: correct backend entry point - #301
Merged
Merged
Conversation
CLAUDE.md's Quick Start pointed at `cd backend && go run .` and listed backend/main.go as the entry point. Neither exists: backend/ is `package tracewaybackend`, a library facade over cmd, so `go run .` fails and `go build -o x .` exits 0 while silently emitting a static archive instead of a binary. The real entry point is ./cmd/traceway. scripts/build-oxc-shim.sh printed the identical stale command. That one matters more than it looks: the oxc dev shell points developers straight at this script. Also notes that JWT_SECRET has to be set before the backend will start. DB_TYPE and PORTS are deliberately not mentioned -- they no longer need setting once the startup defaults land. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
FrameAutomata
force-pushed
the
docs/fix-backend-entry-point
branch
from
August 25, 2026 16:44
7696aa2 to
f667e8b
Compare
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
2 participants
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.
What
CLAUDE.md's Quick Start pointed atcd backend && go run .and listedbackend/main.goas the entry point. Neither exists.backend/ispackage tracewaybackend— a library facade overcmd. So:go run .fails outrightgo build -o x .exits 0 while silently emitting a!<arch>static archive instead of a binaryThe real entry point is
./cmd/traceway.Changes
go run .→go run ./cmd/tracewaybackend/main.gowithtraceway.go,cmd/run.go,cmd/traceway/main.go, andcmd/traceway-runner/scripts/build-oxc-shim.shprinted the identical stale command. That one matters more than it looks — theoxcdev shell in chore: add Nix dev shells for backend and frontend #302 points developers straight at this script.JWT_SECRETmust be set before the backend startsVerification
go build -o x ./cmd/tracewayproduces a 90MB ELF executable; the old form produces a 78KB archive.Merge order
DB_TYPE=sqliteandPORTS=8082as required, because the backend panicked twice without them. #305 removes both panics, so that guidance has been trimmed out and onlyJWT_SECRETremains.If this lands before #305, the Quick Start command will still panic on
DB_TYPEand:80and the docs won't say so. Landing #305 first makes this page accurate immediately.🤖 Generated with Claude Code