#tui #address #japan #terminal #postal #user-interface

app jposta

A fast and intuitive Terminal User Interface (TUI) tool for searching Japanese postal codes and addresses

1 unstable release

new 0.1.0 Dec 3, 2024

#682 in Text processing

MIT license

180KB
179 lines

jposta ๐Ÿ“ฎ

A fast and intuitive Terminal User Interface (TUI) tool for searching Japanese postal codes and addresses. ๐Ÿ—พ

jposta_demo

โœจ Features

  • ๐Ÿ” Real-time postal code lookup with partial matching
  • ๐Ÿˆฏ Address search with Japanese text (kanji/kana)
  • โŒจ๏ธ Interactive TUI with keyboard navigation
  • ๐Ÿ“œ Scrollable results with formatting
  • ๐Ÿ”„ Dual search modes

๐Ÿš€ Installation

cargo install jposta

๐ŸŽฎ Usage

Start the application:

jposta

โŒจ๏ธ Keyboard Controls

  • Tab: Toggle between postal code and address search modes
  • โ†‘/โ†“: Scroll through results
  • Backspace: Delete input
  • Esc: Exit

๐Ÿ” Search Modes

  1. Postal Code Search ๐Ÿ“ซ

    • Enter numbers (e.g., "100" for all codes starting with 100)
    • Results show full addresses with kana readings
  2. Address Search ๐Ÿข

    • Enter text in Japanese (e.g., "ๆธ‹่ฐท" or "ใ‚ทใƒ–ใƒค")
    • Matches any part of the address

๐Ÿ“ Example Output

ใ€’1000001
ๆฑไบฌ้ƒฝๅƒไปฃ็”ฐๅŒบๅƒไปฃ็”ฐ
ใƒˆใ‚ฆใ‚ญใƒงใ‚ฆใƒˆใƒใƒจใƒ€ใ‚ฏใƒใƒจใƒ€

๐Ÿ› ๏ธ Building from Source

git clone https://github.com/nwiizo/jposta
cd jposta
cargo build --release

๐Ÿ“ฆ Dependencies

  • ๐Ÿ–ฅ๏ธ ratatui
  • โšก crossterm
  • ๐Ÿ“จ jpostcode_rs

๐Ÿ“œ License

MIT License

๐Ÿค Contributing

  1. Fork the repository
  2. Create your feature branch
  3. Commit your changes
  4. Push to the branch
  5. Create a Pull Request

๐Ÿ™ Acknowledgments

  • Based on the jpostcode_rs library
  • Japanese postal code data provided by Japan Post

๐Ÿ‘ค Author

nwiizo

Dependencies

~8โ€“14MB
~107K SLoC