Repository navigation
docs: give the README a lead, badges, and a quick start it was missing - #19
Merged
Merged
Conversation
The README opened with three paragraphs of prose and never said how to run the project. Add a one-line description, CodeQL/license/language badges, an explicit note that there is no hosted demo because the dataset is imported locally, and a Quick start taken verbatim from the scripts in the root, backend and frontend package.json files, plus the API endpoint table. Adds five bullets on the decisions worth noticing — the importer that normalizes USCIS schema drift across fiscal years, storing source-level rows so legitimate duplicate employer-year records survive, refresh as a first-class operation with recorded sync metadata, keeping AI enrichment separate from authoritative data, and rate limiting the enrichment route that costs money per call. Screenshots cannot be captured here, so that section names the three shots that would help most with their paths and pre-written, commented-out image lines. Co-Authored-By: Claude Opus 5 (1M context) <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
1 participant
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.
The README opened with three paragraphs of prose and never said how to run the project. This adds the missing front matter and the missing Quick start.
Added: a one-line description, CodeQL / license / top-language badges (each verified 200), an explicit note that there is no hosted demo because the dataset is imported into local SQLite, a Screenshots placeholder section, What it demonstrates technically, a Quick start with an API endpoint table, Status and License. The existing prose is kept and reordered so Data Source precedes Quick start.
Note on sourcing: VisaTrack-Pro has no entry in the master documents repo — it is absent from the career document §5 and from all five industry resumes. Every claim here is therefore taken from the repository itself:
backend/scripts/importCSV.js,syncUSCIS.jsnode-cronscheduling and sync-run metadata —backend/services/dataSync.js,USCIS_SYNC_SCHEDULEin.env.exampleroutes/enrich.jsgeneralLimiteron/apiand a tighterenrichLimiteron/api/enrich,backend/server.js:26-53Quick start commands are copied verbatim from the root, backend and frontend
package.jsonscripts; the endpoint table matches the routes mounted inserver.js. No metric was invented.Only
codeql.ymlexists as a workflow, so the build badge is the CodeQL one, labelled as such rather than implying a test suite that isn't there.Screenshots the owner needs to capture are listed in the README's Screenshots section, each with its target path and a pre-written, commented-out image line. Nothing in the README references an image that does not exist.
Only
README.md(and adocs/screenshots/README.mdplaceholder) is touched, to stay clear of the concurrent.project.json/ LICENSE work.🤖 Generated with Claude Code