first: add docs and create vite project
This commit is contained in:
50
README.md
Normal file
50
README.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# 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ě: pomocí npm příkazem `npm i -g bun`
|
||||
- Win NT:
|
||||
1. ze stránky https://bun.sh/
|
||||
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. ze stránky https://bun.sh/
|
||||
2. z `extra` repozitáře příkazem `pacman -S bun`
|
||||
- MacOS:
|
||||
1. ze stránky https://bun.sh/
|
||||
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/`
|
||||
|
||||
## 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`). Zdrojový kód je dostupný na https://git.martinpetr.dev/binekrasik/webshell
|
||||
|
||||
```md
|
||||
Copyright 2026 Vendelín Mžik
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
```
|
||||
Reference in New Issue
Block a user