README.hu.md

RozsdásFilc: E-Kréta konzol kliens Rustban

English README

FONTOS!

Ha v0.5.21-ről frissítéshez újra kell csinálni a bejelentkezéseket. Ez azért szükséges, mivel a v0.5.22-től kezdve titkosítással vannak tárolva a kódok.

1. Ki kell törölni a régi bejelentkezéseket. Alice ezeket erre találná meg:
   • linux: /home/alice/.config/rsfilc/credentials.toml
   • windows: C:\Users\Alice\AppData\Roaming\rsfilc\credentials.toml
   • mac: /Users/Alice/Library/Application Support/rsfilc/credentials.toml
2. Hozd létre újból a bejelentkezéseket a rsfilc user --create használatával.

Letöltés

• Rust
• cargo install --locked rsfilc

  legújabb, béta: cargo install --locked --git "https://codeberg.org/jark/rsfilc"

segédprogramok

opcionális, ajánlott

• lynx: az élvezhetőbb üzenet-megjelenítés érdekében
• w3m: az élvezhetőbb üzenet-megjelenítés érdekében

autókitöltés:

Bash

Add a ~/.bashrc végére :

eval "$(rsfilc completions bash)"

Zsh

Add a ~/.zshrc végére :

eval "$(rsfilc completions zsh)"

Fish

Add a ~/.config/fish/config.fish végére:

rsfilc completions fish | source

PowerShell

Add a végére a beállításaidnak (így találod echo $profile PowerShell-ben):

Invoke-Expression (& { (rsfilc completions powershell | Out-String) })

Elvish

Add a ~/.elvish/rc.elv végére:

eval (rsfilc completions elvish | slurp)

Használat

rsfilc --help

Finomságok

nem rendszerhez kötött: nincs különösebben letesztelve, de elvileg fut

• linuxon
• windowson
• macOSen
• androidon Termuxon
• mindenen amit támogat a Rust

API

• Kréta API Url-ek lekérése (nem tudom mire jók)

• iskolák lekérése reFilc API-ból

• felhasználó adatainak lekérése (json)

  • token
  • általános információk
  • jegyek
  • órarend
  • üzenetek
    • csatolmányok
  • előre bejelentett számonkérések
  • hiányzások

• felhasználó adatainak használhatóvá tétele (struktúrák)

  • token
  • általános információk
  • jegyek
  • órarend
  • üzenetek
    • csatolmányok
  • előre bejelentett számonkérések
  • hiányzások

CLI

• API alapvető használata
• kért adatok alapvető megjelenítése
• több fiókos rendszer
• üzenetek (html) elfogadható megjelenítése
• üzenetek (html) megjelenítése w3m-mel vagy lynx-el ha lehetséges
• shell autókitöltések: [bash, zsh, fish, elvish, powershell]
• hibajelentések: esetleg fern
• segítőkész hibaüüzenetek
• kb minden cache-elése a valódi élmény érdekében
  • token
  • órarend
  • jegyek
  • felhasználó adatai
  • hiányzások
  • bejelentett számonkérések
  • üzenetek
• jelszavak titkosítása mentéshez
• üzenetek küldése
• osztályátlagok
• ügyintézések lekérése
• ügyintézések indítása
• ...

TUI

• külön oldalak

  • jegyek
  • órarend
  • ...

• adatok szép megjelenítése

  • órarendnek táblázat
  • pl jegyeknek diagram
  • ...

Elismerések

Az API alapvetően ez alapján a dokumentáció alapján valósult meg. Kódinspiráció a reFilcből. Autókitöltés leírás innen: zoxide