Update README for SQLCipher-first backend and current frontend/sidecar behavior
This commit is contained in:
parent
a436d57ce5
commit
941cafba39
21
README.md
21
README.md
@ -16,7 +16,7 @@ journal/
|
||||
│ └── static/ Static assets
|
||||
├── scripts/ PowerShell dev, build, publish, and cache helpers
|
||||
├── docs/ Internal design docs
|
||||
└── journal/ Runtime data directories (vault/, data/)
|
||||
└── journal/ Runtime data directories (vault/)
|
||||
```
|
||||
|
||||
## Deployment Modes
|
||||
@ -133,7 +133,7 @@ Journal.slnx (Visual Studio solution — Core + Sidecar + SmokeTests)
|
||||
```
|
||||
Entry (thin command dispatcher — shared by all three hosts)
|
||||
├── Fragments/ IFragmentService → FragmentService → SQLiteFragmentRepository (SQLCipher)
|
||||
├── Entries/ IEntryFileService → EntryFileService → DiskEntryFileRepository
|
||||
├── Entries/ IEntryFileService → EntryFileService → SqliteEntryFileRepository
|
||||
│ IEntrySearchService → EntrySearchService (raw content + structured filters)
|
||||
│ JournalParser (date / section / checkbox / fragment parsing)
|
||||
├── Lists/ IListService → ListService → SqliteListRepository
|
||||
@ -263,13 +263,12 @@ Tauri commands exposed to the frontend:
|
||||
| `set_ui_settings` | Persist tag/fragment-type settings |
|
||||
| `shutdown` | Stop the sidecar and exit the app |
|
||||
|
||||
Sidecar path resolution order (relative to root):
|
||||
Sidecar path resolution order:
|
||||
|
||||
1. `Journal.Sidecar.exe` in root
|
||||
2. `publish/Journal.Sidecar.exe`
|
||||
3. `Journal.Sidecar/bin/Debug/net10.0/Journal.Sidecar.exe`
|
||||
4. `Journal.Sidecar/bin/Release/net10.0/win-x64/publish/Journal.Sidecar.exe`
|
||||
5. Recursive scan of `Journal.Sidecar/`
|
||||
1. Exact sidecar binary path if the configured root is already the executable
|
||||
2. `<root>/Journal.Sidecar(.exe)`
|
||||
3. Recursive scan of `<root>/Journal.Sidecar/`
|
||||
4. Tauri bundled resource path: `<resourceDir>/bin/Journal.Sidecar(.exe)`
|
||||
|
||||
### Frontend State
|
||||
|
||||
@ -400,10 +399,10 @@ Error:
|
||||
In addition to stdin/stdout protocol, `Journal.Sidecar` supports direct CLI subcommands:
|
||||
|
||||
```powershell
|
||||
# Load/decrypt all vaults into data workspace
|
||||
# Load/decrypt vault snapshot into SQLCipher DB workspace
|
||||
dotnet run --project Journal.Sidecar -- vault load
|
||||
|
||||
# Save (rebuild) monthly vaults from decrypted markdown files
|
||||
# Save (rebuild) vault snapshot from SQLCipher DB
|
||||
dotnet run --project Journal.Sidecar -- vault save
|
||||
|
||||
# Search entries (query + filters)
|
||||
@ -478,7 +477,7 @@ Key registrations:
|
||||
- `IDatabaseSessionService` → `DatabaseSessionService` (singleton)
|
||||
- `IFragmentRepository` → `SqliteFragmentRepository` (singleton, SQLCipher-backed)
|
||||
- `IFragmentService` → `FragmentService` (singleton)
|
||||
- `IEntryFileRepository` → `DiskEntryFileRepository` (singleton)
|
||||
- `IEntryFileRepository` → `SqliteEntryFileRepository` (singleton, SQLCipher-backed)
|
||||
- `IEntryFileService` → `EntryFileService` (singleton)
|
||||
- `IListRepository` → `SqliteListRepository` (singleton)
|
||||
- `IListService` → `ListService` (singleton)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user