updated the project README to reflect the actual implementation of th… - #64
Open
fastrack0926 wants to merge 1 commit into
Open
fastrack0926 wants to merge 1 commit into
fastrack0926 wants to merge 1 commit into
Conversation
|
@fastrack0926 is attempting to deploy a commit to the Andrei's projects Team on Vercel. A member of the Team first needs to authorize it. |
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.
This PR updates the project README to reflect the actual implementation of the app instead of the earlier aspirational/product-marketing version. It aligns the documentation with the codebase’s current architecture, including Privy authentication, GitHub integration, Prisma-backed data models, and the bounty marketplace workflow.
What this change includes
corrected the auth stack to match the real implementation
clarified the app’s purpose as a GitHub bounty marketplace MVP
added a more accurate project structure overview
documented the current environment variables and setup flow
described the key workflow, architecture, and current roadmap more honestly
improved developer usability by making the README read like a real project guide rather than a pitch document
Why this matters
The previous README described a broader vision and outdated setup steps that did not match the code in the repository. This update reduces confusion for contributors and makes it easier for new developers to understand how the system works and how to run it locally.
Result
The documentation is now better aligned with the codebase and more useful for onboarding, setup, and contribution.