Remove frontend codebase and add comprehensive documentation #47
Conversation
…een, and TypeScript configuration files
…Settlement screens - Introduced Friends Screens documentation including Friends List, Friend Detail, Add Friend, Friend Search Results. - Added Groups Screens documentation covering Groups List, Group Details, Group Management, Join Group. - Created Main Navigation documentation detailing Home Screen, Notifications Screen, Profile Menu, Activity Detail Screen. - Developed Settlement Screens documentation featuring Settlement Summary, Optimized Settlement, Record Payment, Payment Confirmation, Payment History.
❌ Deploy Preview for splitwizer failed. Why did it fail? →
|
WalkthroughThis update introduces a comprehensive suite of documentation files detailing the design system, folder structure, UI/UX specifications, and user flows for the SplitWiser mobile app. Simultaneously, it removes the entire frontend React Native codebase, including configuration, authentication logic, screens, and project metadata, leaving only documentation in place. Changes
Suggested labels
Poem
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #47 +/- ##
==========================================
+ Coverage 72.79% 73.95% +1.16%
==========================================
Files 17 19 +2
Lines 1669 1225 -444
Branches 154 140 -14
==========================================
- Hits 1215 906 -309
+ Misses 400 319 -81
+ Partials 54 0 -54
🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/frontend-user-flow.md (1)
81-84: Use an en-dash for numeric ranges“3-4 screens” should use an en-dash “3–4 screens” per style guides.
-3. **Sign Up** → Email, password, confirm password fields -4. **Email Verification** → Verify email address (if required) -5. **Onboarding** → 3-4 screens explaining key features +3. **Sign Up** → Email, password, confirm password fields +4. **Email Verification** → Verify email address (if required) +5. **Onboarding** → 3–4 screens explaining key featuresdocs/screens/main-navigation.md (1)
5-34: Add a language identifier to fenced wire-frame blocksMarkdown-lint rule MD040 is triggered because the code fences have no language.
Addingtext(orplaintext) silences the linter without affecting rendering.-``` +```text ┌─────────────────────────────┐ │ SplitWiser [🔔] [👤] │ ...(Apply the same change to every wire-frame block in this file.)
Also applies to: 98-127, 150-179, 201-229
docs/screens/auth-screens.md (1)
6-34: Specify a language on all fenced code blocks
markdownlintflags MD040 multiple times here.
Prefix eachwithtext to keep the sketches monospace while satisfying the rule.-``` +```text ┌─────────────────────────────┐ │ │ │ [ Logo/Icon ] │(Repeat for every wire-frame block in this document.)
Also applies to: 67-94, 124-150, 164-207, 211-230
docs/screens/expense-creation.md (1)
6-42: Silence MD040 by tagging fenced blocksAll wire-frame fences lack a language spec.
Addtextto the opening back-ticks.-``` +```text ┌─────────────────────────────┐ │ ← Add Expense [✓] │Apply to every block in this file.
Also applies to: 91-127, 166-204, 244-279, 323-359
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
docs/Group-Screen-Flow.pngis excluded by!**/*.pngfrontend/package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (18)
docs/design-system.md(1 hunks)docs/folder-structure.md(1 hunks)docs/frontend-ui-design.md(1 hunks)docs/frontend-user-flow.md(1 hunks)docs/screens/auth-screens.md(1 hunks)docs/screens/expense-creation.md(1 hunks)docs/screens/friends-screens.md(1 hunks)docs/screens/groups-screens.md(1 hunks)docs/screens/main-navigation.md(1 hunks)docs/screens/settlement-screens.md(1 hunks)frontend/App.tsx(0 hunks)frontend/README.md(0 hunks)frontend/app.json(0 hunks)frontend/contexts/AuthContext.tsx(0 hunks)frontend/package.json(0 hunks)frontend/screens/HomeScreen.tsx(0 hunks)frontend/screens/LoginScreen.tsx(0 hunks)frontend/tsconfig.json(0 hunks)
💤 Files with no reviewable changes (8)
- frontend/tsconfig.json
- frontend/README.md
- frontend/App.tsx
- frontend/package.json
- frontend/app.json
- frontend/screens/LoginScreen.tsx
- frontend/screens/HomeScreen.tsx
- frontend/contexts/AuthContext.tsx
🧰 Additional context used
🪛 LanguageTool
docs/screens/main-navigation.md
[uncategorized] ~38-~38: A determiner appears to be missing. Consider inserting it.
Context: ...etails, and monthly spending analytics. Top bar includes notification bell icon and...
(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~38-~38: You might be missing the article “a” here.
Context: ...ly spending analytics. Top bar includes notification bell icon and profile avatar. Bottom na...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~38-~38: You might be missing the article “a” here.
Context: ...bar includes notification bell icon and profile avatar. Bottom navigation with three ma...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[duplication] ~56-~56: Possible typo: you repeated a word.
Context: ... subtle elevation #### Overall Balance Card - Card Type: Elevated card with level 1 elev...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~62-~62: Possible typo: you repeated a word.
Context: ...balance breakdown #### Recent Activity Section - Section Header: "Recent Activity" using `titl...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~71-~71: Possible typo: you repeated a word.
Context: ...Chart Component**: Interactive spending chart - Chart Types: Bar chart, pie chart, or line ...
(ENGLISH_WORD_REPEAT_RULE)
docs/frontend-user-flow.md
[typographical] ~83-~83: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...dress (if required) 5. Onboarding → 3-4 screens explaining key features 6. **Pr...
(HYPHEN_TO_EN)
[duplication] ~87-~87: Possible typo: you repeated a word.
Context: ...rect to home screen #### Existing User Login 1. Login Screen → Email/password or Google Sig...
(ENGLISH_WORD_REPEAT_RULE)
[misspelling] ~97-~97: Did you mean the verb “log in”?
Context: ...om email link) 5. Login → Return to login with new credentials ### 2. Group Mana...
(LOG_IN)
[uncategorized] ~110-~110: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...irst expense #### Joining a Group 1. Groups List → Tap "Join Group" button 2. **J...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[uncategorized] ~144-~144: You might be missing the article “the” here.
Context: ...**: - Select members to include in split - Real-time calculation of per-per...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[duplication] ~181-~181: Possible typo: you repeated a word.
Context: ...Friends Management Journey #### Adding Friends 1. Friends List → Tap "Add friend" 2. **Search M...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~189-~189: Possible missing preposition found.
Context: ...n** → Friend receives notification 4. Acceptance → Friend appears in friends list ###...
(AI_HYDRA_LEO_MISSING_OF)
docs/screens/auth-screens.md
[misspelling] ~61-~61: This word is normally spelled as one.
Context: ...lid credentials - Keyboard handling and auto-focus - Accessibility support with screen rea...
(EN_COMPOUNDS_AUTO_FOCUS)
[misspelling] ~103-~103: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...or form completion - Navigation back to login screen - Consistent styling with login ...
(LOG_IN)
[duplication] ~240-~240: Possible typo: you repeated a word.
Context: ...Navigation Flow 1. Welcome → Next → Groups 2. Groups → Next → Smart Splits, Skip → Main Ap...
(ENGLISH_WORD_REPEAT_RULE)
docs/screens/settlement-screens.md
[uncategorized] ~52-~52: Possible missing comma found.
Context: ...view of all outstanding balances across groups with options for optimized settlements ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~77-~77: Possible missing preposition found.
Context: ...ual groups #### Settlement Options - Optimize Payments: Algorithm-based minimal tra...
(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~140-~140: Possible missing preposition found.
Context: ...─────────────────┘ ``` ### Description Algorithmic settlement optimization showing the min...
(AI_HYDRA_LEO_MISSING_OF)
[grammar] ~225-~225: Using ‘plenty’ without ‘of’ is considered to be informal.
Context: ...payments with payment method selection, amount confirmation, and automatic balance updates across r...
(PLENTY_OF_NOUNS)
[grammar] ~261-~261: Probably a preposition is missing after ‘references’.
Context: ...ntegration flow - Add payment notes and references - Confirm payment with automatic balance updates ...
(ATD_VERBS_TO_COLLOCATION)
[uncategorized] ~340-~340: You might be missing the article “the” here.
Context: ...rds - Return Home: Navigate back to main app screens - View History: Access ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[duplication] ~413-~413: Possible typo: you repeated a word.
Context: ...action Date**: Clear timestamp for each payment - Payment Direction: Visual distinction between...
(ENGLISH_WORD_REPEAT_RULE)
docs/screens/groups-screens.md
[uncategorized] ~42-~42: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ist with simplified group cards showing name, member count, and last activity. Featu...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[duplication] ~132-~132: Possible typo: you repeated a word.
Context: ...h essential balance info #### Expenses Section - Section Header: "EXPENSES" with clear typogra...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~140-~140: Consider adding a hyphen.
Context: ...on for expense creation - Position: Bottom right corner - Clean Design: Simple plus ...
(TOP_LEFT_CORNER)
[uncategorized] ~144-~144: You might be missing the article “the” here.
Context: ...on without text ### Interactions - Tap back button to return to groups list - Tap s...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~145-~145: You might be missing the article “the” here.
Context: ...k button to return to groups list - Tap settle up button to initiate settlement proces...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~145-~145: You might be missing the article “the” here.
Context: ...list - Tap settle up button to initiate settlement process - Tap expense cards to view det...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[misspelling] ~226-~226: This word is normally spelled as one.
Context: ...in multiple formats - Delete group with multi-step confirmation ## Join Group Screen ###...
(EN_COMPOUNDS_MULTI_STEP)
docs/screens/expense-creation.md
[grammar] ~50-~50: Using ‘plenty’ without ‘of’ is considered to be informal.
Context: ...scription field with placeholder text - Amount input with currency formatting - Category dro...
(PLENTY_OF_NOUNS)
[misspelling] ~59-~59: This word is normally spelled as one.
Context: ...Visual Feedback*: Clean indication of multi-step process without numbers - **Minimal Des...
(EN_COMPOUNDS_MULTI_STEP)
[uncategorized] ~130-~130: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...─────┘ ``` ### Description Second step allowing selection of who paid for the expense. ...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~130-~130: Possible missing comma found.
Context: ...ense. Supports both single and multiple payers with amount specification for each paye...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~130-~130: Using ‘plenty’ without ‘of’ is considered to be informal.
Context: ...ts both single and multiple payers with amount specification for each payer. Progress shown with cle...
(PLENTY_OF_NOUNS)
[grammar] ~136-~136: Using ‘plenty’ without ‘of’ is considered to be informal.
Context: ...otal calculation and validation - Smart amount distribution when switching modes - Clear visual fee...
(PLENTY_OF_NOUNS)
[grammar] ~144-~144: Using ‘plenty’ without ‘of’ is considered to be informal.
Context: ... Toggle**: Radio buttons with automatic amount adjustment #### Payer Selection - Member List...
(PLENTY_OF_NOUNS)
[grammar] ~159-~159: Using ‘plenty’ without ‘of’ is considered to be informal.
Context: ... - Check/uncheck members with automatic amount calculations - Manual amount adjustment with real-ti...
(PLENTY_OF_NOUNS)
[grammar] ~160-~160: Using ‘plenty’ without ‘of’ is considered to be informal.
Context: ... automatic amount calculations - Manual amount adjustment with real-time total updates - Visual i...
(PLENTY_OF_NOUNS)
[grammar] ~288-~288: Using ‘plenty’ without ‘of’ is considered to be informal.
Context: ...tails showing each person's share - Net amount calculation (what each person owes/is owed) - Final...
(PLENTY_OF_NOUNS)
docs/folder-structure.md
[uncategorized] ~421-~421: You might be missing the article “the” here.
Context: ...te Management 1. Define entity types in types/ folder 2. Create Redux slice wit...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/screens/friends-screens.md
[uncategorized] ~43-~43: You might be missing the article “a” here.
Context: ...shared group count with quick access to detailed view. ### Key Features - Friend cards ...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~55-~55: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...y ### Component Breakdown #### Friend Cards - Avatar: Profile picture or initia...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[grammar] ~58-~58: This phrase is duplicated. You should probably use “shared groups” only once.
Context: ...alance Status**: Net balance across all shared groups - Shared Groups: Count of groups where both users are...
(PHRASE_REPETITION)
[uncategorized] ~63-~63: “to” seems less likely than “the”.
Context: ...- You Owe: Red text indicating debt to friend - Owes You: Green text indic...
(AI_HYDRA_LEO_CP_TO_THE)
[duplication] ~154-~154: Possible typo: you repeated a word.
Context: ... per-group balance display #### Recent Activity - Activity Feed: Recent expenses involving both ...
(ENGLISH_WORD_REPEAT_RULE)
🪛 markdownlint-cli2 (0.17.2)
docs/screens/auth-screens.md
6-6: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
67-67: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
124-124: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
164-164: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
187-187: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
210-210: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
docs/screens/settlement-screens.md
6-6: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
96-96: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
183-183: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
268-268: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
352-352: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
docs/screens/groups-screens.md
6-6: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
69-69: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
154-154: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
231-231: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
docs/screens/expense-creation.md
6-6: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
91-91: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
166-166: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
244-244: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
323-323: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
docs/screens/friends-screens.md
6-6: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
83-83: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
175-175: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
262-262: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (6)
docs/frontend-ui-design.md (1)
1-49: Looks solid – no action neededWell-structured document, clear cross-linking, and no markdown-lint or language-tool issues detected.
docs/screens/groups-screens.md (1)
6-7: Add language identifiers to fenced code blocks to satisfy markdownlint (MD040)
Every ASCII wireframe block is opened with bare triple-backticks, triggering MD040.
Usetext(orplain) to indicate the content is not source code.-``` +```textApply the same change to the blocks starting at lines 69, 154 and 231.
[ suggest_nitpick ]Also applies to: 69-70, 154-155, 231-232
docs/folder-structure.md (1)
8-9: Missing language tags in directory-tree code fences
The folder tree (line 8) and navigation tree (line 372) need a language identifier to silence MD040.-``` +```text[ suggest_nitpick ]
Also applies to: 372-373
docs/screens/settlement-screens.md (1)
6-7: Specify a language for all fenced wireframe blocks
Five wireframe sections open with bare backticks; addtextfor clarity and lint compliance.-``` +```text[ suggest_nitpick ]
Also applies to: 96-97, 183-184, 268-269, 352-353
docs/screens/friends-screens.md (1)
6-7: Label fenced blocks to avoid MD040 violations
Inserttextafter the opening backticks of each ASCII-art block.-``` +```text[ suggest_nitpick ]
Also applies to: 83-84, 175-176, 262-263
docs/design-system.md (1)
8-63: Well-structured; code fences already typed
All fenced snippets correctly declaretypescript, meeting lint rules and improving syntax highlighting.
[ approve_code_changes ]
✅ Deploy Preview for split-but-wiser canceled.
|
1 participant
Eliminate the frontend codebase, including key components and configuration files. Introduce detailed documentation for Friends, Groups, Main Navigation, and Settlement screens to enhance understanding and usability of the application.
Summary by CodeRabbit