Skip to content

docs(readme): update architecture diagram to reflect current file structure #162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andrerfneves merged 1 commit into from
Jun 9, 2026
Merged

docs(readme): update architecture diagram to reflect current file structure #162

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 23 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,26 +106,35 @@ Storybook will be available at `http://localhost:6006`.
```
src/
├── components/
│ ├── ui/ # shadcn/ui base components
│ ├── ui/ # shadcn/ui base components
│ │ ├── button.tsx
│ │ ├── input.tsx
│ │ ├── card.tsx
│ │ └── ...
│ ├── header.tsx # App header with theme toggle
│ ├── search-input.tsx # Invoice/address input
│ ├── invoice-details.tsx # Decoded invoice display
│ ├── error-display.tsx # Error/warning callout component
│ └── theme-provider.tsx # Theme context provider
│ ├── header.tsx # App header with theme toggle & menu
│ ├── search-input.tsx # Invoice/address input
│ ├── invoice-details.tsx # Decoded invoice display
│ ├── error-display.tsx # Error/warning callout component
│ ├── payment-hash-verifier.tsx # Payment hash verification tool
│ ├── qr-scanner.tsx # QR code scanner modal
│ ├── theme-provider.tsx # Theme context provider
│ ├── *.stories.tsx # Storybook stories for each component
│ └── *.test.tsx # Component unit tests
├── constants/
│ └── keys.js # Shared BOLT11/LNURL/BOLT12 key constants
├── lib/
│ ├── bolt11.js # BOLT11 invoice encode/decode
│ ├── bolt11-networks.test.js # BOLT11 network tests
│ └── utils.ts # Utility functions (cn helper)
│ ├── bolt11.js # BOLT11 invoice encode/decode
│ ├── bolt11-networks.test.js # BOLT11 network tests
│ └── utils.ts # Utility functions (cn helper)
├── utils/
│ ├── app-routes.ts # Reserved route and invoice URL helpers
│ ├── invoices.js # Invoice parsing logic
│ ├── internet-identifier.js # Lightning Address validation
│ └── keys.js # Key formatting utilities
└── app.tsx # Main application component
│ ├── app-routes.ts # Reserved route and invoice URL helpers
│ ├── invoices.js # Invoice parsing logic
│ ├── internet-identifier.js # Lightning Address validation
│ ├── keys.js # Key formatting utilities
│ └── *.test.js # Utility function unit tests
├── app.tsx # Main application component
├── main.tsx # React DOM entry point
└── index.css # Tailwind CSS imports and theme variables
```

### Key Libraries
Expand Down
Loading