Rewrite README to match the actual code - #1
Merged
Merged
Conversation
The README had drifted from the implementation. This rewrites it against the current backend and frontend source: - Correct the POST /api/query request/response shapes and document /api/query/demo, the health check and both rate limiters accurately. - Document /api/db/upload and /api/db/execute as implemented (UUID file ids, imported_csv/imported_json tables, structured `mongo` payload, Neo4j credentials, default 1000-row limit). - Separate query languages that can be generated from those that can be executed (Cassandra, DynamoDB, Elasticsearch, Redis and GraphQL are generation-only). - Replace the environment variable list with the variables the code actually reads; drop TOKEN_EXPIRY and TEST_* which are never used. - Add the model alias table and the Auto routing heuristics. - Describe chat context as the last three completed exchanges and note that utils/conversationMemory.js is not wired into any route. - Add honest security notes (unauthenticated /api/db routes, open CORS, default JWT secret, unused xss dependency) and known limitations. - Add a Windows note for the POSIX-style npm scripts, Docker caveats, and a Mermaid architecture diagram in place of the ASCII one. - Fix project structure, tech stack and contributing sections. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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.
Summary
README.mdwas the only markdown file in the repo, and it had drifted from the implementation. This rewrites it against the current backend and frontend source. It is a docs-only change.What was wrong and is now fixed
POST /api/queryrequest/response shapes were wrong (it does not acceptsourceType/connectionStringand does not returnusage/raw)./api/query/demo, the health check, both rate limiters, upload/execute payloads (UUID file ids,imported_csv/imported_jsontables, structuredmongopayload, Neo4j credentials) are now documented as implemented.find, Neo4j).TOKEN_EXPIRYandTEST_*, which are never used. Notes that there is no.env.example.utils/conversationMemory.jsis not called by any route./api/db/*routes, open CORS, the default JWT secret and the unusedxssdependency. The old README both claimed CORS was restricted and said it was open.Not changed (noticed while reviewing, out of scope)
.github/workflows/node.js.ymlrunsnpm ci/npm testat the repo root, but there is no rootpackage.json(andpackage-lock.jsonis git-ignored), so the workflow cannot pass as written./api/db/*has no auth middleware, andutils/conversationMemory.jsis unused.Test plan
querycraft-backend/andquerycraft-frontend/src/🤖 Generated with Claude Code