Repository navigation
docs: rewrite README and .env.example to match the actual stack (Closes #15) - #29
Merged
merlik787-droi merged 3 commits intoAug 27, 2026
Merged
Conversation
Rewrite the onboarding docs to match the actual project: React 19 / Vite 7 / Tailwind 4 / Redux Toolkit + Zustand / React Query stack, the real src/ layout and scripts, and only the env vars the source reads (dropping the stale Stellar/Soroban/contract variables and the [TEMPLATE] line). Mark the wallet/store/NFT/token features as not yet implemented and add CONTRIBUTING.md with setup and codebase-map guidance. Also restores green CI on the dashboard merge: wire Dashboard to the useLeaderboard hook (the previous merge left an undefined leaderboardView reference) and clear storage between AuthService tests. Closes Riddlrealm#15 Generated with Codebuff 🤖 Co-Authored-By: Codebuff <noreply@codebuff.com>
The committed lockfile was missing the @vitest/coverage-v8 dependency subtree, so `npm ci` (the CI install step) failed with EUSAGE on every run. Regenerated the lockfile with npm install so the coverage tooling resolves cleanly. Generated with Codebuff 🤖 Co-Authored-By: Codebuff <noreply@codebuff.com>
merlik787-droi
approved these changes
Aug 27, 2026
Closed
5 tasks
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
Rewrites the onboarding documentation for issue #15 so it describes the project that actually exists in the tree:
src/layout, and the real scripts (dev,build,lint,test,test:watch,preview). Removes all claims about React 18, Context API,src/utils,src/contexts, Stellar SDK, Soroban RPC, and Freighter..env.example— documents only the variables the source actually reads (VITE_BACKEND_API_URL,VITE_GOOGLE_CLIENT_ID,VITE_CONTRIBUTORS_REPO), removes the[TEMPLATE]line, and drops the unreadVITE_STELLAR_NETWORK/VITE_SOROBAN_RPC_URL/VITE_CONTRACT_ADDRESSvariables.Mindmint-BackendandMindmint-Contract(the latter is not yet integrated).CI note (required to get a green pipeline)
The repo's
mainCI is currently red: the last run (merge of PR #25) fails 3 tests. Since CI on this repo only runsnpm test, a docs-only PR would inherit those failures, so this PR also includes the minimal fixes to restore green CI:src/pages/Dashboard.tsx— the dashboard merge left an undefinedleaderboardViewreference that crashes the page at runtime (and fails the Dashboard tests +tsc). Wired it to the existinguseLeaderboard()hook and dropped the stale unused import.src/services/AuthService.test.ts— tests share the jsdom storage; the "fails closed" test saw the token persisted by an earlier test. ClearedlocalStorage/sessionStoragebetween tests.Verified locally:
npm test(51/51 pass),npm run lint, andnpm run buildall succeed.Closes #15