edit readme
This commit is contained in:
parent
e7c02c7feb
commit
545dd4ed0b
1 changed files with 49 additions and 18 deletions
67
README.md
67
README.md
|
|
@ -1,43 +1,74 @@
|
|||
# Wherry
|
||||
|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
FTP/SFTP клиент написанный на Rust с UI на egui/eframe.
|
||||
FTP/SFTP клиент на Tauri 2: бэкенд на Rust, фронтенд — vanilla HTML/CSS/JS.
|
||||
|
||||
## Стек
|
||||
|
||||
- **egui/eframe** — нативный GUI (чистый Rust, без веба)
|
||||
- **Rust** — протоколы, файловая система, очередь передач
|
||||
- **Tauri 2** — нативная оболочка (Rust-бэкенд + WebView-фронтенд)
|
||||
- **tokio** — async runtime
|
||||
- **ssh2** / **suppaftp** — протоколы SFTP / FTP(S)
|
||||
- **rusqlite** — локальное хранилище (сайты, история, закладки, настройки)
|
||||
- **системный keychain** — хранение паролей (UI их не читает)
|
||||
- фронтенд — чистые HTML/CSS/JS без сборщика, i18n на 12 языков
|
||||
|
||||
## Протоколы
|
||||
|
||||
| Версия | Протоколы |
|
||||
|--------|-------------------|
|
||||
| v1 | SFTP, FTP, FTPS |
|
||||
| v2 | S3, WebDAV |
|
||||
| v3 | Google Drive, Dropbox |
|
||||
| Протокол | Статус |
|
||||
|----------|--------------|
|
||||
| SFTP | реализован |
|
||||
| FTP | реализован |
|
||||
| FTPS | заглушка |
|
||||
|
||||
## Возможности
|
||||
|
||||
- Chunked upload/download с событиями прогресса
|
||||
- Pause/cancel в очереди передач
|
||||
- Операции над удалёнными файлами: новая папка / удалить / переименовать
|
||||
- Drag & drop, горячие клавиши (Cmd/Ctrl в зависимости от платформы)
|
||||
- Welcome-экран: сохранённые сайты, недавние подключения, шорткаты
|
||||
- Settings: General / Appearance / Connections / History / Security / Transfers / About
|
||||
|
||||
В разработке: полноценная реализация FTPS, Site Manager UI (создание/редактирование сайтов).
|
||||
|
||||
## Разработка
|
||||
|
||||
```bash
|
||||
cargo run
|
||||
# запуск в dev-режиме (нужен tauri-cli: cargo install tauri-cli)
|
||||
cargo tauri dev
|
||||
|
||||
# обычная сборка Rust-крейта
|
||||
cargo build
|
||||
```
|
||||
|
||||
## Архитектура
|
||||
|
||||
```
|
||||
src/
|
||||
├── domain/ -- модели данных (Connection, FileEntry, TransferTask, Site)
|
||||
├── protocols/ -- RemoteFs trait + sftp.rs, ftp.rs
|
||||
├── transfer/ -- очередь, воркеры, прогресс
|
||||
├── storage/ -- SQLite (сайты), keychain (пароли)
|
||||
├── fs/ -- локальная ФС + реестр удалённых соединений
|
||||
├── ui/ -- egui панели (в разработке)
|
||||
└── main.rs -- точка входа eframe
|
||||
src/ -- Rust-бэкенд (Tauri)
|
||||
├── domain/ -- модели данных (Connection, FileEntry, TransferTask, Site)
|
||||
├── protocols/ -- RemoteFs trait + sftp/, ftp/
|
||||
├── transfer/ -- очередь, воркер, прогресс
|
||||
├── storage/ -- SQLite (sites, history, bookmarks, settings) + keychain (пароли)
|
||||
├── fs/ -- локальная ФС + реестр удалённых соединений
|
||||
├── i18n/ -- строки для бэкенда
|
||||
├── commands.rs -- Tauri-команды (IPC для фронтенда)
|
||||
├── lib.rs / main.rs -- точки входа
|
||||
└── tauri.conf.json -- конфигурация приложения
|
||||
|
||||
frontend/ -- фронтенд (vanilla JS, без сборщика)
|
||||
├── js/
|
||||
│ ├── components/ -- UI-компоненты
|
||||
│ ├── i18n/ -- локали (en, ru, de, fr, es, it, pt, pl, tr, ja, ko, zh)
|
||||
│ ├── ipc.js -- обёртка над Tauri IPC
|
||||
│ └── main.js -- точка входа
|
||||
└── css/ -- theme, layout, components
|
||||
```
|
||||
|
||||
## Лицензия
|
||||
|
||||
GPL-3.0-only, см. [LICENSE](LICENSE).
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue