webshell/README.md

webshell

Webová aplikace implementující terminal shell jako webové rozhraní. Aplikace je zdarma hostovaná přes Vercel a je veřejně dostupná na adrese https://webshell.binekrasik.dev/

buildování

0. Pro buildování je potřeba software třetích stran:
   • Bun -> JavaScriptový/TypeScriptový runtime. Stáhnout lze z více zdrojů. Po instalaci doporučuji přidat Bun executable do PATH. Je možno použít Node.JS a npm.
     • Univerzálně:
       1. pomocí npm příkazem npm i -g bun
       2. z oficiální stránky https://bun.sh/
     • Win NT:
       1. z powershellu příkazem powershell -c "irm bun.sh/install.ps1 | iex"
       2. přes winget powershellovým příkazem winget install --id Oven-sh.Bun
       3. pomocí chocolatey příkazem choco install bun
     • Arch Linux:
       1. z terminálu příkazem curl -fsSL https://bun.sh/install | bash
       2. z extra repozitáře příkazem pacman -S bun
     • MacOS:
       1. z terminálu příkazem curl -fsSL https://bun.sh/install | bash
       2. pomocí homebrew příkazem brew tap oven-sh/bun && brew install bun
   • Vite -> Builder a packer pro webové aplikace
     • Již definováno jako závislost v projektovém package.json
   • Sass -> Nástavba CSS, slouží čistě pro srozumitelnost v rozsáhlejších projektech
     • Závislost v package.json
1. Otevřete systémovou shell v projektovém adresáři (nejpravděpodobněji .../webshell/)
2. Stáhněte potřebné balíčky a jejich závislosti
   • přes Bun příkazem bun i
   • pommocí npm příkazem npm i
3. Spusťte dev server pomocí <bun/npm> run dev
4. Stránka je nyní lokálně dostupná na http://localhost:3000/
5. (volitelné) Apliakci je možné buildnout pomocí <bun/npm> run build. Statická verze stránky je nyní dostupná v adresáři webshell/dist/

testování

Aplikace je testována v následujících prohlížečích:

• Chromium 146.0.7680.153 (Official Build) Arch Linux (64-bit)
• Zen Browser 1.19.3b (Firefox 148.0.2) (64-bit)

licence

Tato webová aplikace včetně jejího zdrojového kódu je veřejně dostupná pod licencí Apache 2.0 (SPDX: Apache-2.0), jejíž celé znění je dostupné v LICENSE.md. Zdrojový kód je veřejně dostupný na https://git.martinpetr.dev/binekrasik/webshell