Repository navigation
docs: final README, contributing guide and up-to-date project docs - #34
Merged
Merged
Conversation
- README rewritten without screenshots: pitch, two-minute tour of the live demo, full feature map (brief + beyond), correctness guarantees, architecture, stack, verified test counts (76 backend, 96 browser), setup, documentation index and team with real names - CONTRIBUTING rewritten for ongoing work: ground rules for stock changes, protected-main workflow, conventional commits, local checks, code style, migrations, security and bug reports - ROADMAP: mark one-click reorder done; list board, activity charts, cinematic landing, auth video backgrounds and demo dataset - ARCHITECTURE / TEAM_PLAN / frontend README: middleware.ts -> proxy.ts, Gmail -> Brevo SMTP relay, drop stale placeholder and setup notes - DEMO: Count next is shipped; update the judge Q&A accordingly
Harsha-code-per
requested review from
Cholan-kinnera and
loktrishal-05
as code owners
September 26, 2026 12:59
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
- centered header with live app / API buttons, CI and stack badges and a section index; no screenshots (the live app is linked instead) - problem statement coverage table, module by module - new "How StockSense meets the evaluation criteria" table: database design, no BaaS, minimal third-party APIs, dynamic data, validation, logic, modularity, coding standards, security, performance, scalability, usability, debugging, CI/CD and Git teamwork - database design section with an ER diagram and the rules enforced in the schema - remove unused screenshot files from docs/ and frontend/
This branch was successfully deployed
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.
What
Final pass over everything visitors and evaluators read on the repository.
mainworkflow, Conventional Commits, local checks that mirror CI, code style, migrations, security, bug reports.middleware.ts→proxy.ts, Gmail → Brevo SMTP relay, removed stale placeholder and setup notes.Docs only; no code changes.