+Useful tools for developer and people working in IT. Try it! +
+ You can override listening port using environment variable `PORT` (docker option `-e PORT=8888`). You can serve the app from a subfolder using environment variable `BASE_URL` (docker option @@ -21,8 +25,6 @@ than on the JavaScript heap. Especially for UI improvements and translation. And for anything else. -Want to support this fork of IT Tools: [Buy me a coffee](https://www.buymeacoffee.com/sharevb) - ## HTTPS is recommended Some tools like PGP encryption rely on WebCrypto API that is only available in HTTPS/SSL. Also, if you want to use PWA, HTTPS is required. diff --git a/docker-compose.yml b/docker-compose.yml index 56caf7afc3..15f23ece2b 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -5,4 +5,6 @@ services: pull_policy: always restart: unless-stopped ports: - - 8080:8080 # Since Docker base image is now nginx-unpriviledged, docker image now listen to 8080 and no more 80. \ No newline at end of file + - 8080:8080 # Since Docker base image is now nginx-unpriviledged, docker image now listen to 8080 and no more 80. + environment: + VITE_LANGUAGE: ${VITE_LANGUAGE:-en} diff --git a/docker-entrypoint.d/18-runtime-config.sh b/docker-entrypoint.d/18-runtime-config.sh new file mode 100755 index 0000000000..1dc861a932 --- /dev/null +++ b/docker-entrypoint.d/18-runtime-config.sh @@ -0,0 +1,19 @@ +#!/bin/sh + +set -eu + +config_file=/usr/share/nginx/html/runtime-config.js +default_locale=${VITE_LANGUAGE:-en} + +case "$default_locale" in + [a-z][a-z] | [a-z][a-z]-[A-Z][A-Z]) ;; + *) + echo "18-runtime-config.sh: warning: invalid VITE_LANGUAGE='$default_locale', using en" >&2 + default_locale=en + ;; +esac + +if [ -w "$config_file" ]; then + sed "s/__DEFAULT_LOCALE__/$default_locale/" "$config_file" > "$config_file.tmp" + mv "$config_file.tmp" "$config_file" +fi diff --git a/docs/README.de.md b/docs/README.de.md new file mode 100644 index 0000000000..c9ad059d7c --- /dev/null +++ b/docs/README.de.md @@ -0,0 +1,114 @@ +## Wichtige Änderung für das Container-Image + +Da das Basis-Image jetzt `nginx-unpriviledged` ist, lauscht der Container auf Port **8080** und nicht auf 80. Sie müssen daher Ihre Port-Zuordnung aktualisieren, d.h. von `8080:80` zu `8080:8080`. + +Sie können den lauschenden Port mit der Umgebungsvariable `PORT` überschreiben (Docker-Option `-e PORT=8888`). + +## Pull-Request willkommen + +Besonders für UI-Verbesserungen und Übersetzungen. Und für alles andere. + +Sie möchten diesen Fork von IT Tools unterstützen: [Buy me a coffee](https://www.buymeacoffee.com/sharevb) + +## HTTPS wird empfohlen + +Einige Tools wie PGP-Verschlüsselung verlassen sich auf die WebCrypto-API, die nur in HTTPS/SSL verfügbar ist. Außerdem wird HTTPS benötigt, wenn Sie PWA verwenden möchten. + +Sie sollten also auch bei internen Installationen HTTPS mit Let's Encrypt über DNS-Challenge aktivieren. + +## Mitwirkende + +Vielen Dank an alle, die bereits beigetragen haben! + +[](https://github.com/sharevb/it-tools/graphs/contributors) + +## Entwicklung unter Windows + +Die Verwendung von WSL2 wird für die Entwicklung mit VSCode unter Windows empfohlen. Die direkte Entwicklung ist schwierig (wegen einiger Abhängigkeiten). + +## Hinzugefügte Funktionen + +- Fast alle [Original it-tools PRs, 192 von mir](https://github.com/CorentinTh/it-tools/pulls) +- 95% der [Original it-tools Issues](https://github.com/CorentinTh/it-tools/issues) +- Vollständige UI-Übersetzung in viele Sprachen (Google-übersetzt) +- Viele [neue Tools](https://sharevb-it-tools.vercel.app/about) +- Viele Fehlerkorrekturen und Verbesserungen +- Viele Anpassungen (Docker-Version) + +## Container-Images + +[GitHub Container Registry](https://github.com/sharevb/it-tools/pkgs/container/it-tools): `ghcr.io/sharevb/it-tools:latest` + +[Docker Hub](https://hub.docker.com/r/sharevb/it-tools): `sharevb/it-tools:latest` + +## In Docker Compose verwenden + +```yml +services: + it-tools: + container_name: it-tools + image: sharevb/it-tools:latest + pull_policy: always + restart: unless-stopped + ports: + - 8080:8080 +``` + +## Tools filtern und eigene Startseite hinzufügen + +Sie können eigene Inhalte zur Startseite hinzufügen, indem Sie `home.custom.md` nach `/usr/share/nginx/html` einhängen. + +Sie können verfügbare Tools filtern, indem Sie `tools-filter.json` nach `/usr/share/nginx/html` einhängen. + +## Beitragen + +### Empfohlene IDE-Einrichtung + +[VSCode](https://code.visualstudio.com/) mit folgenden Erweiterungen: + +- [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (und Vetur deaktivieren) +- [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) +- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) +- [i18n Ally](https://marketplace.visualstudio.com/items?itemName=lokalise.i18n-ally) + +### Projekteinrichtung + +```sh +pnpm install --ignore-scripts +``` + +### Kompilieren und Heißen Neustart für Entwicklung + +```sh +pnpm dev +``` + +### Typprüfung, Kompilieren und Minifizieren für Produktion + +```sh +pnpm build +``` + +### Unit-Tests mit Vitest ausführen + +```sh +pnpm test +``` + +### Mit ESLint prüfen + +```sh +pnpm lint +``` + +### Ein neues Tool erstellen + +Um ein neues Tool zu erstellen, gibt es ein Skript, das die Vorlage generiert. Führen Sie einfach aus: + +```sh +pnpm run script:create:tool my-tool-name +``` + +## Lizenz + +Dieses Projekt ist unter [GNU GPLv3](LICENSE). diff --git a/docs/README.es.md b/docs/README.es.md new file mode 100644 index 0000000000..56571fb50b --- /dev/null +++ b/docs/README.es.md @@ -0,0 +1,114 @@ +## Cambio importante para la imagen del contenedor + +Dado que la imagen base ahora es `nginx-unpriviledged`, el contenedor escuchará en el puerto **8080** y no en el 80. Por lo tanto, necesita actualizar su mapeo de puertos, es decir, de `8080:80` a `8080:8080`. + +Puede sobrescribir el puerto de escucha usando la variable de entorno `PORT` (opción docker `-e PORT=8888`). + +## PR Bienvenido + +Especialmente para mejoras de UI y traducción. Y para cualquier otra cosa. + +¿Quieres apoyar este fork de IT Tools?: [Buy me a coffee](https://www.buymeacoffee.com/sharevb) + +## Se recomienda HTTPS + +Algunas herramientas como el cifrado PGP dependen de la API WebCrypto que solo está disponible en HTTPS/SSL. También, si quieres usar PWA, se requiere HTTPS. + +Entonces, incluso en instalaciones internas, deberías habilitar HTTPS usando Let's Encrypt con DNS Challenge. + +## Contribuidores + +¡Muchas gracias a todas las personas que ya han contribuido! + +[](https://github.com/sharevb/it-tools/graphs/contributors) + +## Desarrollo en Windows + +Se recomienda usar WSL2 para desarrollar con VSCode en Windows. El desarrollo directo es complicado (debido a algunas dependencias). + +## Funciones añadidas + +- Casi todos los [PR de it-tools original, 192 míos](https://github.com/CorentinTh/it-tools/pulls) +- 95% de los [problemas de it-tools original](https://github.com/CorentinTh/it-tools/issues) +- Traducción completa de UI en muchos idiomas (traducido por Google) +- Muchos [nuevas herramientas](https://sharevb-it-tools.vercel.app/about) +- Muchas correcciones de errores y mejoras +- Muchas personalizaciones (versión Docker) + +## Imágenes de contenedor + +[GitHub Container Registry](https://github.com/sharevb/it-tools/pkgs/container/it-tools): `ghcr.io/sharevb/it-tools:latest` + +[Docker Hub](https://hub.docker.com/r/sharevb/it-tools): `sharevb/it-tools:latest` + +## Usar en archivo Docker Compose + +```yml +services: + it-tools: + container_name: it-tools + image: sharevb/it-tools:latest + pulse_policy: always + restart: unless-stopped + ports: + - 8080:8080 +``` + +## Filtrar herramientas y agregar contenido personalizado en home + +Puedes agregar contenido personalizado en la página de inicio montando un `home.custom.md` en `/usr/share/nginx/html`. + +Puedes filtrar las herramientas disponibles montando `tools-filter.json` en `/usr/share/nginx/html`. + +## Contribuir + +### Configuración de IDE recomendada + +[VSCode](https://code.visualstudio.com/) con las siguientes extensiones: + +- [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (y desactivar Vetur) +- [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) +- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) +- [i18n Ally](https://marketplace.visualstudio.com/items?itemName=lokalise.i18n-ally) + +### Configuración del proyecto + +```sh +pnpm install --ignore-scripts +``` + +### Compilar y recargar en caliente para desarrollo + +```sh +pnpm dev +``` + +### Verificación de tipos, compilar y minificar para producción + +```sh +pnpm build +``` + +### Ejecutar pruebas unitarias con Vitest + +```sh +pnpm test +``` + +### Lint con ESLint + +```sh +pnpm lint +``` + +### Crear una nueva herramienta + +Para crear una nueva herramienta, hay un script que genera la plantilla. Simplemente ejecuta: + +```sh +pnpm run script:create:tool my-tool-name +``` + +## Licencia + +Este proyecto está bajo [GNU GPLv3](LICENSE). diff --git a/docs/README.fr.md b/docs/README.fr.md new file mode 100644 index 0000000000..9b7f2aeffd --- /dev/null +++ b/docs/README.fr.md @@ -0,0 +1,114 @@ +## Changement important pour l'image du conteneur + +Maintenant que l'image de base est `nginx-unpriviledged`, le conteneur écoute sur le port **8080** et non 80. Vous devez donc mettre à jour votre mapping de ports, c'est-à-dire de `8080:80` à `8080:8080`. + +Vous pouvez remplacer le port d'écoute en utilisant la variable d'environnement `PORT` (option docker `-e PORT=8888`). + +## PR Bienvenue + +Surtout pour les améliorations de l'interface utilisateur et la traduction. Et pour tout autre chose. + +Vous voulez soutenir ce fork d'IT Tools: [Buy me a coffee](https://www.buymeacoffee.com/sharevb) + +## HTTPS est recommandé + +Certains outils comme le chiffrement PGP s'appuient sur l'API WebCrypto qui n'est disponible qu'en HTTPS/SSL. De plus, si vous voulez utiliser PWA, HTTPS est requis. + +Donc, même sur les installations internes, vous devez activer HTTPS en utilisant Let's Encrypt avec DNS Challenge. + +## Contributeurs + +Un grand merci à toutes les personnes qui ont déjà contribué ! + +[](https://github.com/sharevb/it-tools/graphs/contributors) + +## Développement sous Windows + +L'utilisation de WSL2 est recommandée pour développer avec VSCode sur Windows. Le développement direct est délicat (à cause de certaines dépendances). + +## Fonctionnalités ajoutées + +- Presque [tous les PR d'it-tools original, 192 des miens](https://github.com/CorentinTh/it-tools/pulls) +- 95% des [problèmes d'it-tools original](https://github.com/CorentinTh/it-tools/issues) +- Traduction complète de l'interface utilisateur dans de nombreuses langues (traduit par Google) +- De nombreux [nouveaux outils](https://sharevb-it-tools.vercel.app/about) +- De nombreuses corrections de bugs et améliorations +- De nombreuses personnalisations (version Docker) + +## Images de conteneur + +[GitHub Container Registry](https://github.com/sharevb/it-tools/pkgs/container/it-tools): `ghcr.io/sharevb/it-tools:latest` + +[Docker Hub](https://hub.docker.com/r/sharevb/it-tools): `sharevb/it-tools:latest` + +## Utiliser dans un fichier Docker Compose + +```yml +services: + it-tools: + container_name: it-tools + image: sharevb/it-tools:latest + pull_policy: always + restart: unless-stopped + ports: + - 8080:8080 +``` + +## Filtrer les outils et ajouter du contenu personnalisé + +Vous pouvez ajouter du contenu personnalisé sur la page d'accueil en montant un `home.custom.md` dans `/usr/share/nginx/html`. + +Vous pouvez filtrer les outils disponibles en montant `tools-filter.json` dans `/usr/share/nginx/html`. + +## Contribuer + +### Configuration IDE recommandée + +[VSCode](https://code.visualstudio.com/) avec les extensions suivantes : + +- [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (et désactiver Vetur) +- [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) +- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) +- [i18n Ally](https://marketplace.visualstudio.com/items?itemName=lokalise.i18n-ally) + +### Configuration du projet + +```sh +pnpm install --ignore-scripts +``` + +### Compiler et recharger à chaud pour le développement + +```sh +pnpm dev +``` + +### Vérification des types, compilation et minification pour la production + +```sh +pnpm build +``` + +### Exécuter les tests unitaires avec Vitest + +```sh +pnpm test +``` + +### Lint avec ESLint + +```sh +pnpm lint +``` + +### Créer un nouvel outil + +Pour créer un nouvel outil, il existe un script qui génère le modèle. Il suffit d'exécuter : + +```sh +pnpm run script:create:tool my-tool-name +``` + +## Licence + +Ce projet est sous [GNU GPLv3](LICENSE). diff --git a/docs/README.it.md b/docs/README.it.md new file mode 100644 index 0000000000..208f67fd79 --- /dev/null +++ b/docs/README.it.md @@ -0,0 +1,114 @@ +## Cambiamento importante per l'immagine del contenitore + +Poiché l'immagine di base ora è `nginx-unpriviledged`, il contenitore ascolterà sulla porta **8080** e non sulla 80. Quindi devi aggiornare il tuo mapping delle porte, cioè da `8080:80` a `8080:8080`. + +Puoi sovrascrivere la porta di ascolto usando la variabile d'ambiente `PORT` (opzione docker `-e PORT=8888`). + +## PR Benvenuti + +Specialmente per miglioramenti dell'interfaccia utente e traduzione. E per qualsiasi altra cosa. + +Vuoi supportare questo fork di IT Tools: [Buy me a coffee](https://www.buymeacoffee.com/sharevb) + +## HTTPS è raccomandato + +Alcuni strumenti come la crittografia PGP si affidano all'API WebCrypto che è disponibile solo in HTTPS/SSL. Inoltre, se vuoi usare PWA, HTTPS è richiesto. + +Quindi, anche nelle installazioni interne, dovresti abilitare HTTPS usando Let's Encrypt con DNS Challenge. + +## Contributori + +Un grande ringraziamento a tutte le persone che hanno già contribuito! + +[](https://github.com/sharevb/it-tools/graphs/contributors) + +## Sviluppo su Windows + +Si consiglia l'uso di WSL2 per sviluppare usando VSCode su Windows. Lo sviluppo diretto è complicato (a causa di alcune dipendenze). + +## Funzionalità aggiunte + +- Quasi tutti i [PR di it-tools originali, 192 miei](https://github.com/CorentinTh/it-tools/pulls) +- 95% dei [problemi di it-tools originali](https://github.com/CorentinTh/it-tools/issues) +- Traduzione completa dell'interfaccia utente in molte lingue (tradotto da Google) +- Molti [nuovi strumenti](https://sharevb-it-tools.vercel.app/about) +- Molte correzioni di bug e miglioramenti +- Molte personalizzazioni (versione Docker) + +## Immagini del contenitore + +[GitHub Container Registry](https://github.com/sharevb/it-tools/pkgs/container/it-tools): `ghcr.io/sharevb/it-tools:latest` + +[Docker Hub](https://hub.docker.com/r/sharevb/it-tools): `sharevb/it-tools:latest` + +## Usa in file Docker Compose + +```yml +services: + it-tools: + container_name: it-tools + image: sharevb/it-tools:latest + pull_policy: always + restart: unless-stopped + ports: + - 8080:8080 +``` + +## Filtra strumenti e aggiungi contenuto personalizzato alla home + +Puoi aggiungere contenuto personalizzato alla pagina home montando un `home.custom.md` in `/usr/share/nginx/html`. + +Puoi filtrare gli strumenti disponibili montando `tools-filter.json` in `/usr/share/nginx/html`. + +## Contribuire + +### Configurazione IDE consigliata + +[VSCode](https://code.visualstudio.com/) con le seguenti estensioni: + +- [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (e disabilita Vetur) +- [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) +- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) +- [i18n Ally](https://marketplace.visualstudio.com/items?itemName=lokalise.i18n-ally) + +### Configurazione del progetto + +```sh +pnpm install --ignore-scripts +``` + +### Compila e Hot-Reload per lo sviluppo + +```sh +pnpm dev +``` + +### Controllo tipi, compilazione e minificazione per produzione + +```sh +pnpm build +``` + +### Esegui test unitari con Vitest + +```sh +pnpm test +``` + +### Lint con ESLint + +```sh +pnpm lint +``` + +### Crea un nuovo strumento + +Per creare un nuovo strumento, c'è uno script che genera il boilerplate. Esegui semplicemente: + +```sh +pnpm run script:create:tool my-tool-name +``` + +## Licenza + +Questo progetto è sotto [GNU GPLv3](LICENSE). diff --git a/docs/README.ja.md b/docs/README.ja.md new file mode 100644 index 0000000000..de66868365 --- /dev/null +++ b/docs/README.ja.md @@ -0,0 +1,114 @@ +## コンテナイメージの変更点 + +ベースイメージが`nginx-unpriviledged`になったため、コンテナは80番ではなく**8080**番ポートでListenします。ポートマッピングを`8080:80`から`8080:8080`に更新する必要があります。 + +環境変数`PORT`でリスニングポートを上書きできます(Dockerオプション `-e PORT=8888`)。 + +## プルリクエスト歓迎 + +UIの改善や翻訳、特にその他の貢献大歓迎です。 + +このIT Toolsのフォークを支持してください: [Buy me a coffee](https://www.buymeacoffee.com/sharevb) + +## HTTPS推奨 + +PGP暗号化などの一部ツールは、HTTPS/SSLでのみ利用可能なWebCrypto APIに依存しています。また、PWAを使用する場合もHTTPSが必要です。 + +したがって、内部インストールでもLet's EncryptのDNS Challengeを使用してHTTPSを有効にしてください。 + +## コントリビューター + +すでに貢献していただいたすべての方に感謝いたします! + +[](https://github.com/sharevb/it-tools/graphs/contributors) + +## Windowsでの開発 + +VSCodeを使用してWindowsで開発するにはWSL2を使用することを推奨します。直接の開発は一部の依存関係のため困難です。 + +## 追加された機能 + +- 元のit-toolsのほぼすべてのPR(私のものは192個) +- 元のit-toolsの問題の95% +- 多くの言語での完全なUI翻訳(Google翻訳) +- 多くの[new tools](https://sharevb-it-tools.vercel.app/about) +- 多くのバグ修正と機能強化 +- 多くのカスタマイズ(Dockerバージョン) + +## コンテナイメージ + +[GitHub Container Registry](https://github.com/sharevb/it-tools/pkgs/container/it-tools): `ghcr.io/sharevb/it-tools:latest` + +[Docker Hub](https://hub.docker.com/r/sharevb/it-tools): `sharevb/it-tools:latest` + +## Docker Composeファイルでの使用 + +```yml +services: + it-tools: + container_name: it-tools + image: sharevb/it-tools:latest + pull_policy: always + restart: unless-stopped + ports: + - 8080:8080 +``` + +## ツールのフィルタリングとカスタムホームコンテンツの追加 + +`home.custom.md`を`/usr/share/nginx/html`にマウントして、首页にカスタムコンテンツを追加できます。 + +`tools-filter.json`を`/usr/share/nginx/html`にマウントして、利用可能なツールをフィルタリングできます。 + +## コントリビューション + +### 推奨IDEセットアップ + +[VSCode](https://code.visualstudio.com/) 以下の拡張機能付き: + +- [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)(Veturは無効化) +- [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) +- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) +- [i18n Ally](https://marketplace.visualstudio.com/items?itemName=lokalise.i18n-ally) + +### プロジェクトセットアップ + +```sh +pnpm install --ignore-scripts +``` + +### 開発用のコンパイルとホットリロード + +```sh +pnpm dev +``` + +### 本番ビルドの型チェック、コンパイル、圧縮 + +```sh +pnpm build +``` + +### Vitestでのユニットテスト実行 + +```sh +pnpm test +``` + +### ESLintでリント + +```sh +pnpm lint +``` + +### 新しいツールの作成 + +新しいツールを作成するには、ボイラープレートを生成するスクリプトがあります。単純に実行: + +```sh +pnpm run script:create:tool my-tool-name +``` + +## ライセンス + +このプロジェクトは[GNU GPLv3](LICENSE)の下にあります。 diff --git a/docs/README.ko.md b/docs/README.ko.md new file mode 100644 index 0000000000..efb2323e00 --- /dev/null +++ b/docs/README.ko.md @@ -0,0 +1,112 @@ +## 컨테이너 이미지의 중요한 변경 + +기본 이미지가 `nginx-unpriviledged`가 되었으므로 컨테이너는 80이 아닌 **8080** 포트에서 수신합니다. 因此,您需要更新端口映射,即从 `8080:80` 改为 `8080:8080`。您可以使用环境变量 `PORT` 覆盖侦听端口(docker 选项 `-e PORT=8888`)。 + +## PR 환영 + +특히 UI 개선 및 번역에 환영합니다. 그리고 다른 모든 것에도 환영합니다. + +이 IT Tools 포크를 지원하고 싶으신가요: [Buy me a coffee](https://www.buymeacoffee.com/sharevb) + +## HTTPS 권장 + +PGP 암호화와 같은 일부 도구는 HTTPS/SSL에서만 사용 가능한 WebCrypto API에 의존합니다. 또한 PWA를 사용하려면 HTTPS가 필요합니다. + +따라서 내부 설치에서도 DNS 챌린지를 사용하여 Let's Encrypt로 HTTPS를 활성화해야 합니다. + +## 기여자 + +이미 기여해 주신 모든 분들께 감사드립니다! + +[](https://github.com/sharevb/it-tools/graphs/contributors) + +## Windows에서의 개발 + +VSCode를 사용하여 Windows에서 개발하려면 WSL2 사용을 권장합니다. 직접 개발은 일부 종속성으로 인해 까다로울 수 있습니다. + +## 추가된 기능 + +- 원래 it-tools의 거의 모든 PR, 192개는 제 것입니다 +- 원래 it-tools 이슈의 95% +- 많은 언어의 전체 UI 번역 (Google 번역) +- 많은 [새 도구](https://sharevb-it-tools.vercel.app/about) +- 많은 버그 수정 및 개선 +- 많은 사용자 정의 (Docker 버전) + +## 컨테이너 이미지 + +[GitHub Container Registry](https://github.com/sharevb/it-tools/pkgs/container/it-tools): `ghcr.io/sharevb/it-tools:latest` + +[Docker Hub](https://hub.docker.com/r/sharevb/it-tools): `sharevb/it-tools:latest` + +## Docker Compose 파일에서 사용 + +```yml +services: + it-tools: + container_name: it-tools + image: sharevb/it-tools:latest + pull_policy: always + restart: unless-stopped + ports: + - 8080:8080 +``` + +## 도구 필터링 및 사용자 정의 홈 콘텐츠 추가 + +`home.custom.md`를 `/usr/share/nginx/html`에 마운트하여 홈 페이지에 사용자 정의 콘텐츠를 추가할 수 있습니다. + +`tools-filter.json`을 `/usr/share/nginx/html`에 마운트하여 사용 가능한 도구를 필터링할 수 있습니다. + +## 기여 + +### 권장 IDE 설정 + +다음 확장이 있는 [VSCode](https://code.visualstudio.com/): + +- [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (Vetur 비활성화) +- [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) +- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) +- [i18n Ally](https://marketplace.visualstudio.com/items?itemName=lokalise.i18n-ally) + +### 프로젝트 설정 + +```sh +pnpm install --ignore-scripts +``` + +### 개발을 위한 컴파일 및 핫 리로드 + +```sh +pnpm dev +``` + +### 프로덕션을 위한 타입 체크, 컴파일 및 축소 + +```sh +pnpm build +``` + +### Vitest로 단위 테스트 실행 + +```sh +pnpm test +``` + +### ESLint로 린트 + +```sh +pnpm lint +``` + +### 새 도구 만들기 + +새 도구를 만들려면 보일러플레이트를 생성하는 스크립트가 있습니다. 다음과 같이 실행하세요: + +```sh +pnpm run script:create:tool my-tool-name +``` + +## 라이선스 + +이 프로젝트는 [GNU GPLv3](LICENSE) 하에 있습니다. diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000000..a394bed0d5 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,24 @@ +# Multi-Language README + +This folder contains translated versions of the README file. + +## Available Languages + +| Language | File | +| ---------- | ---------------------------- | +| 中文 | [README.zh.md](README.zh.md) | +| Español | [README.es.md](README.es.md) | +| Français | [README.fr.md](README.fr.md) | +| Deutsch | [README.de.md](README.de.md) | +| 日本語 | [README.ja.md](README.ja.md) | +| 한국어 | [README.ko.md](README.ko.md) | +| Português | [README.pt.md](README.pt.md) | +| Italiano | [README.it.md](README.it.md) | +| Nederlands | [README.nl.md](README.nl.md) | +| Polski | [README.pl.md](README.pl.md) | +| Русский | [README.ru.md](README.ru.md) | +| Türkçe | [README.tr.md](README.tr.md) | +| Українська | [README.uk.md](README.uk.md) | +| Tiếng Việt | [README.vi.md](README.vi.md) | + +Back to [Main README](../README.md) diff --git a/docs/README.nl.md b/docs/README.nl.md new file mode 100644 index 0000000000..bdd762c191 --- /dev/null +++ b/docs/README.nl.md @@ -0,0 +1,114 @@ +## Belangrijke wijziging voor containerimage + +Omdat het basisimage nu `nginx-unpriviledged` is, luistert de container op poort **8080** en niet 80. U moet dus uw poorttoewijzing bijwerken, namelijk van `8080:80` naar `8080:8080`. + +U kunt de luisterpoort overschrijven met de omgevingsvariabele `PORT` (docker-optie `-e PORT=8888`). + +## PR Welkom + +Vooral voor UI-verbeteringen en vertaling. En voor alles anders. + +Wilt u deze fork van IT Tools ondersteunen: [Buy me a coffee](https://www.buymeacoffee.com/sharevb) + +## HTTPS aanbevolen + +Sommige tools zoals PGP-codering zijn afhankelijk van de WebCrypto API die alleen beschikbaar is in HTTPS/SSL. Bovendien is HTTPS vereist als u PWA wilt gebruiken. + +Dus zelfs bij interne installaties moet u HTTPS inschakelen met Let's Encrypt via DNS Challenge. + +## Bijdragers + +Veel dank aan alle mensen die al hebben bijgedragen! + +[](https://github.com/sharevb/it-tools/graphs/contributors) + +## Ontwikkeling onder Windows + +Het gebruik van WSL2 wordt aanbevolen om te ontwikkelen met VSCode op Windows. Directe ontwikkeling is lastig (vanwege enkele afhankelijkheden). + +## Toegevoegde functies + +- Bijna alle [originele it-tools PR's, 192 van mij](https://github.com/CorentinTh/it-tools/pulls) +- 95% van de [originele it-tools problemen](https://github.com/CorentinTh/it-tools/issues) +- Volledige UI-vertaling in veel talen (Google Translated) +- Veel [nieuwe tools](https://sharevb-it-tools.vercel.app/about) +- Veel bugfixes en verbeteringen +- Veel aanpassingen (Docker-versie) + +## Containerimages + +[GitHub Container Registry](https://github.com/sharevb/it-tools/pkgs/container/it-tools): `ghcr.io/sharevb/it-tools:latest` + +[Docker Hub](https://hub.docker.com/r/sharevb/it-tools): `sharevb/it-tools:latest` + +## Gebruiken in Docker Compose-bestand + +```yml +services: + it-tools: + container_name: it-tools + image: sharevb/it-tools:latest + pull_policy: always + restart: unless-stopped + ports: + - 8080:8080 +``` + +## Tools filteren en aangepaste startpagina-inhoud toevoegen + +U kunt aangepaste inhoud toevoegen aan de startpagina door een `home.custom.md` te mounten in `/usr/share/nginx/html`. + +U kunt beschikbare tools filteren door `tools-filter.json` te mounten in `/usr/share/nginx/html`. + +## Bijdragen + +### Aanbevolen IDE-configuratie + +[VSCode](https://code.visualstudio.com/) met de volgende extensies: + +- [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (en Vetur uitschakelen) +- [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) +- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) +- [i18n Ally](https://marketplace.visualstudio.com/items?itemName=lokalise.i18n-ally) + +### Projectconfiguratie + +```sh +pnpm install --ignore-scripts +``` + +### Compileren en Hot-Reload voor ontwikkeling + +```sh +pnpm dev +``` + +### Type-check, compileren en minificeren voor productie + +```sh +pnpm build +``` + +### Unit tests uitvoeren met Vitest + +```sh +pnpm test +``` + +### Linten met ESLint + +```sh +pnpm lint +``` + +### Een nieuwe tool maken + +Om een nieuwe tool te maken, is er een script dat de boilerplate genereert. Voer gewoon uit: + +```sh +pnpm run script:create:tool my-tool-name +``` + +## Licentie + +Dit project is onder [GNU GPLv3](LICENSE). diff --git a/docs/README.pl.md b/docs/README.pl.md new file mode 100644 index 0000000000..f4e5f06a92 --- /dev/null +++ b/docs/README.pl.md @@ -0,0 +1,114 @@ +## Ważna zmiana dla obrazu kontenera + +Ponieważ obraz bazowy to teraz `nginx-unpriviledged`, kontener będzie nasłuchiwać na porcie **8080**, a nie 80. Dlatego musisz zaktualizować mapowanie portów, czyli z `8080:80` na `8080:8080`. + +Możesz nadpisać port nasłuchiwania za pomocą zmiennej środowiskowej `PORT` (opcja docker `-e PORT=8888`). + +## PR Mile widziane + +Szczególnie mile widziane są poprawki interfejsu użytkownika i tłumaczenia. I wszystko inne. + +Chcesz wesprzeć ten fork IT Tools: [Buy me a coffee](https://www.buymeacoffee.com/sharevb) + +## HTTPS jest zalecane + +Niektóre narzędzia, takie jak szyfrowanie PGP, opierają się na WebCrypto API, które jest dostępne tylko w HTTPS/SSL. Ponadto, jeśli chcesz używać PWA, wymagane jest HTTPS. + +Dlatego nawet w instalacjach wewnętrznych powinieneś włączyć HTTPS używając Let's Encrypt z DNS Challenge. + +## Współtwórcy + +Bardzo dziękujemy wszystkim osobom, które już przyczyniły się do projektu! + +[](https://github.com/sharevb/it-tools/graphs/contributors) + +## Programowanie pod Windows + +Zaleca się użycie WSL2 do programowania z VSCode na Windowsie. Bezpośrednie programowanie jest trudne (ze względu na pewne zależności). + +## Dodane funkcje + +- Prawie wszystkie [PR oryginalnego it-tools, 192 moje](https://github.com/CorentinTh/it-tools/pulls) +- 95% [problemów oryginalnego it-tools](https://github.com/CorentinTh/it-tools/issues) +- Pełne tłumaczenie interfejsu użytkownika na wiele języków (tłumaczone przez Google) +- Wiele [nowych narzędzi](https://sharevb-it-tools.vercel.app/about) +- Wiele poprawek błędów i ulepszeń +- Wiele dostosowań (wersja Docker) + +## Obrazy kontenerów + +[GitHub Container Registry](https://github.com/sharevb/it-tools/pkgs/container/it-tools): `ghcr.io/sharevb/it-tools:latest` + +[Docker Hub](https://hub.docker.com/r/sharevb/it-tools): `sharevb/it-tools:latest` + +## Użycie w pliku Docker Compose + +```yml +services: + it-tools: + container_name: it-tools + image: sharevb/it-tools:latest + pull_policy: always + restart: unless-stopped + ports: + - 8080:8080 +``` + +## Filtrowanie narzędzi i dodawanie własnej zawartości strony głównej + +Możesz dodać własną zawartość do strony głównej, montując `home.custom.md` w `/usr/share/nginx/html`. + +Możesz filtrować dostępne narzędzia, montując `tools-filter.json` w `/usr/share/nginx/html`. + +## Współpraca + +### Zalecana konfiguracja IDE + +[VSCode](https://code.visualstudio.com/) z następującymi rozszerzeniami: + +- [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (i wyłącz Vetur) +- [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) +- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) +- [i18n Ally](https://marketplace.visualstudio.com/items?itemName=lokalise.i18n-ally) + +### Konfiguracja projektu + +```sh +pnpm install --ignore-scripts +``` + +### Kompilacja i hot-reload dla rozwoju + +```sh +pnpm dev +``` + +### Sprawdzanie typów, kompilacja i minifikacja dla produkcji + +```sh +pnpm build +``` + +### Uruchomienie testów jednostkowych z Vitest + +```sh +pnpm test +``` + +### Lintowanie z ESLint + +```sh +pnpm lint +``` + +### Tworzenie nowego narzędzia + +Aby utworzyć nowe narzędzie, istnieje skrypt generujący szablon. Po prostu uruchom: + +```sh +pnpm run script:create:tool my-tool-name +``` + +## Licencja + +Ten projekt jest objęty licencją [GNU GPLv3](LICENSE). diff --git a/docs/README.pt.md b/docs/README.pt.md new file mode 100644 index 0000000000..7df8b77fc3 --- /dev/null +++ b/docs/README.pt.md @@ -0,0 +1,114 @@ +## Mudança importante para a imagem do conteneur + +Como a imagem base agora é `nginx-unpriviledged`, o contêiner agora escutará na porta **8080** e não na 80. Portanto, você precisa atualizar seu mapeamento de portas, ou seja, de `8080:80` para `8080:8080`. + +Você pode substituir a porta de escuta usando a variável de ambiente `PORT` (opção docker `-e PORT=8888`). + +## PR Bem-vindo + +Especialmente para melhorias de UI e tradução. E para qualquer outra coisa. + +Quer apoiar este fork do IT Tools: [Buy me a coffee](https://www.buymeacoffee.com/sharevb) + +## HTTPS é recomendado + +Algumas ferramentas como criptografia PGP dependem da API WebCrypto que está disponível apenas em HTTPS/SSL. Além disso, se você quiser usar PWA, HTTPS é necessário. + +Portanto, mesmo em instalações internas, você deve habilitar o HTTPS usando o Let's Encrypt com DNS Challenge. + +## Contribuidores + +Muito obrigado a todas as pessoas que já contribuíram! + +[](https://github.com/sharevb/it-tools/graphs/contributors) + +## Desenvolvimento no Windows + +É recomendado usar WSL2 para desenvolver usando VSCode no Windows. O desenvolvimento direto é complicado (por causa de algumas dependências). + +## Recursos adicionados + +- Quase todos os [PRs do it-tools original, 192 meus](https://github.com/CorentinTh/it-tools/pulls) +- 95% dos [problemas do it-tools original](https://github.com/CorentinTh/it-tools/issues) +- Tradução completa da UI em muitos idiomas (traduzido pelo Google) +- Muitos [novos ferramentas](https://sharevb-it-tools.vercel.app/about) +- Muitas correções de bugs e melhorias +- Muitas personalizações (versão Docker) + +## Imagens de contêiner + +[GitHub Container Registry](https://github.com/sharevb/it-tools/pkgs/container/it-tools): `ghcr.io/sharevb/it-tools:latest` + +[Docker Hub](https://hub.docker.com/r/sharevb/it-tools): `sharevb/it-tools:latest` + +## Usar em arquivo Docker Compose + +```yml +services: + it-tools: + container_name: it-tools + image: sharevb/it-tools:latest + pull_policy: always + restart: unless-stopped + ports: + - 8080:8080 +``` + +## Filtrar ferramentas e adicionar conteúdo personalizado na página inicial + +Você pode adicionar conteúdo personalizado na página inicial montando um `home.custom.md` em `/usr/share/nginx/html`. + +Você pode filtrar as ferramentas disponíveis montando `tools-filter.json` em `/usr/share/nginx/html`. + +## Contribuir + +### Configuração de IDE recomendada + +[VSCode](https://code.visualstudio.com/) com as seguintes extensões: + +- [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (e desativar Vetur) +- [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) +- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) +- [i18n Ally](https://marketplace.visualstudio.com/items?itemName=lokalise.i18n-ally) + +### Configuração do projeto + +```sh +pnpm install --ignore-scripts +``` + +### Compilar e Hot-Reload para Desenvolvimento + +```sh +pnpm dev +``` + +### Verificação de tipos, compilar e minificar para Produção + +```sh +pnpm build +``` + +### Executar testes unitários com Vitest + +```sh +pnpm test +``` + +### Lint com ESLint + +```sh +pnpm lint +``` + +### Criar uma nova ferramenta + +Para criar uma nova ferramenta, existe um script que gera o modelo. Simplesmente execute: + +```sh +pnpm run script:create:tool my-tool-name +``` + +## Licença + +Este projeto está sob [GNU GPLv3](LICENSE). diff --git a/docs/README.ru.md b/docs/README.ru.md new file mode 100644 index 0000000000..7cf6b6b9fc --- /dev/null +++ b/docs/README.ru.md @@ -0,0 +1,114 @@ +## Важное изменение для образа контейнера + +Поскольку базовый образ теперь `nginx-unpriviledged`, контейнер будет прослушивать порт **8080**, а не 80. Поэтому вам нужно обновить сопоставление портов, то есть с `8080:80` на `8080:8080`. + +Вы можете переопределить прослушиваемый порт с помощью переменной окружения `PORT` (опция docker `-e PORT=8888`). + +## Pull Request Приветствуются + +Особенно приветствуются улучшения пользовательского интерфейса и переводы. И все остальное. + +Хотите поддержать этот форк IT Tools: [Buy me a coffee](https://www.buymeacoffee.com/sharevb) + +## Рекомендуется HTTPS + +Некоторые инструменты, такие как шифрование PGP, полагаются на WebCrypto API, который доступен только в HTTPS/SSL. Кроме того, если вы хотите использовать PWA, требуется HTTPS. + +Поэтому даже во внутренних установках следует включить HTTPS с помощью Let's Encrypt с DNS Challenge. + +## Участники + +Большое спасибо всем, кто уже внес свой вклад! + +[](https://github.com/sharevb/it-tools/graphs/contributors) + +## Разработка в Windows + +Рекомендуется использовать WSL2 для разработки с VSCode в Windows. Прямая разработка затруднена (из-за некоторых зависимостей). + +## Добавленные функции + +- Почти все [PR оригинального it-tools, 192 моих](https://github.com/CorentinTh/it-tools/pulls) +- 95% [проблем оригинального it-tools](https://github.com/CorentinTh/it-tools/issues) +- Полный перевод пользовательского интерфейса на многие языки (переведено Google) +- Много [новых инструментов](https://sharevb-it-tools.vercel.app/about) +- Много исправлений ошибок и улучшений +- Много настроек (версия Docker) + +## Образы контейнеров + +[GitHub Container Registry](https://github.com/sharevb/it-tools/pkgs/container/it-tools): `ghcr.io/sharevb/it-tools:latest` + +[Docker Hub](https://hub.docker.com/r/sharevb/it-tools): `sharevb/it-tools:latest` + +## Использование в файле Docker Compose + +```yml +services: + it-tools: + container_name: it-tools + image: sharevb/it-tools:latest + pull_policy: always + restart: unless-stopped + ports: + - 8080:8080 +``` + +## Фильтрация инструментов и добавление пользовательского контента на главную страницу + +Вы можете добавить пользовательский контент на главную страницу, смонтировав `home.custom.md` в `/usr/share/nginx/html`. + +Вы можете фильтровать доступные инструменты, смонтировав `tools-filter.json` в `/usr/share/nginx/html`. + +## Вклад + +### Рекомендуемая настройка IDE + +[VSCode](https://code.visualstudio.com/) со следующими расширениями: + +- [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (и отключить Vetur) +- [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) +- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) +- [i18n Ally](https://marketplace.visualstudio.com/items?itemName=lokalise.i18n-ally) + +### Настройка проекта + +```sh +pnpm install --ignore-scripts +``` + +### Компиляция и горячая перезагрузка для разработки + +```sh +pnpm dev +``` + +### Проверка типов, компиляция и минификация для продакшена + +```sh +pnpm build +``` + +### Запуск юнит-тестов с Vitest + +```sh +pnpm test +``` + +### Линтинг с ESLint + +```sh +pnpm lint +``` + +### Создание нового инструмента + +Для создания нового инструмента есть скрипт, который генерирует шаблон. Просто выполните: + +```sh +pnpm run script:create:tool my-tool-name +``` + +## Лицензия + +Этот проект находится под [GNU GPLv3](LICENSE). diff --git a/docs/README.tr.md b/docs/README.tr.md new file mode 100644 index 0000000000..86d7d7544c --- /dev/null +++ b/docs/README.tr.md @@ -0,0 +1,114 @@ +## Konteyner Görüntüsü için Önemli Değişiklik + +Artık temel görüntü `nginx-unpriviledged` olduğundan, konteyner 80 yerine **8080** numaralı portu dinleyecektir. Bu nedenle port eşleştirmenizi güncellemeniz gerekir, yani `8080:80`'den `8080:8080`'e. + +Dinleme portunu `ORTAM` değişkenini kullanarak geçersiz kılabilirsiniz (docker seçeneği `-e PORT=8888`). + +## PR Hoş Geldin + +Özellikle UI iyileştirmeleri ve çeviri için. Ve diğer her şey için. + +Bu IT Tools fork'unu desteklemek ister misiniz: [Buy me a coffee](https://www.buymeacoffee.com/sharevb) + +## HTTPS Önerilir + +PGP şifreleme gibi bazı araçlar, yalnızca HTTPS/SSL'de mevcut olan WebCrypto API'sine dayanır. Ayrıca, PWA kullanmak istiyorsanız HTTPS gereklidir. + +Bu nedenle, dahili kurulumlarda bile DNS Challenge ile Let's Encrypt kullanarak HTTPS'i etkinleştirmelisiniz. + +## Katkıda Bulunanlar + +Zaten katkıda bulunan tüm insanlara çok teşekkürler! + +[](https://github.com/sharevb/it-tools/graphs/contributors) + +## Windows'ta Geliştirme + +VSCode kullanarak Windows'ta geliştirmek için WSL2 kullanılması önerilir. Doğrudan geliştirme zordur (bazı bağımlılıklar nedeniyle). + +## Eklenen Özellikler + +- Orijinal it-tools'un neredeyse tüm PR'ları, 192'si benim +- Orijinal it-tools sorunlarının %95'i +- Birçok dilde tam UI çevirisi (Google Çeviri tarafından) +- Birçok [yeni araç](https://sharevb-it-tools.vercel.app/about) +- Birçok hata düzeltmesi ve iyileştirme +- Birçok özelleştirme (Docker sürümü) + +## Konteyner Görüntüleri + +[GitHub Container Registry](https://github.com/sharevb/it-tools/pkgs/container/it-tools): `ghcr.io/sharevb/it-tools:latest` + +[Docker Hub](https://hub.docker.com/r/sharevb/it-tools): `sharevb/it-tools:latest` + +## Docker Compose Dosyasında Kullanım + +```yml +services: + it-tools: + container_name: it-tools + image: sharevb/it-tools:latest + pull_policy: always + restart: unless-stopped + ports: + - 8080:8080 +``` + +## Araçları Filtreleme ve Özel Ana Sayfa İçeriği Ekleme + +Ana sayfaya özel içerik eklemek için `/usr/share/nginx/html` konumuna `home.custom.md` bağlayabilirsiniz. + +Kullanılabilir araçları filtrelemek için `/usr/share/nginx/html` konumuna `tools-filter.json` bağlayabilirsiniz. + +## Katkı + +### Önerilen IDE Kurulumu + +Aşağıdaki uzantılara sahip [VSCode](https://code.visualstudio.com/): + +- [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (ve Vetur'u devre dışı bırak) +- [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) +- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) +- [i18n Ally](https://marketplace.visualstudio.com/items?itemName=lokalise.i18n-ally) + +### Proje Kurulumu + +```sh +pnpm install --ignore-scripts +``` + +### Geliştirme için Derleme ve Hot-Reload + +```sh +pnpm dev +``` + +### Üretim için Tür Kontrolü, Derleme ve Minify + +```sh +pnpm build +``` + +### Vitest ile Birim Testlerini Çalıştırma + +```sh +pnpm test +``` + +### ESLint ile Lint + +```sh +pnpm lint +``` + +### Yeni Araç Oluşturma + +Yeni bir araç oluşturmak için şablonu oluşturan bir komut dosyası vardır. Şunu çalıştırın: + +```sh +pnpm run script:create:tool my-tool-name +``` + +## Lisans + +Bu proje [GNU GPLv3](LICENSE) altında lisanslıdır. diff --git a/docs/README.uk.md b/docs/README.uk.md new file mode 100644 index 0000000000..f4cf0a95ec --- /dev/null +++ b/docs/README.uk.md @@ -0,0 +1,114 @@ +## Важлива зміна для образу контейнера + +Оскільки базовий образ тепер `nginx-unpriviledged`, контейнер прослуховуватиме порт **8080**, а не 80. Тому вам потрібно оновити зіставлення портів, тобто з `8080:80` на `8080:8080`. + +Ви можете перевизначити порт прослуховування за допомогою змінної середовища `PORT` (опція docker `-e PORT=8888`). + +## PR Вітаються + +Особливо вітаються покращення інтерфейсу користувача та переклади. І все інше. + +Хочете підтримати цей форк IT Tools: [Buy me a coffee](https://www.buymeacoffee.com/sharevb) + +## Рекомендовано HTTPS + +Деякі інструменти, такі як шифрування PGP, покладаються на WebCrypto API, який доступний лише в HTTPS/SSL. Крім того, якщо ви хочете використовувати PWA, потрібен HTTPS. + +Тому навіть у внутрішніх установках слід увімкнути HTTPS за допомогою Let's Encrypt з DNS Challenge. + +## Учасники + +Величезна подяка всім, хто вже зробив внесок! + +[](https://github.com/sharevb/it-tools/graphs/contributors) + +## Розробка в Windows + +Рекомендовано використовувати WSL2 для розробки з VSCode в Windows. Пряма розробка ускладнена (через деякі залежності). + +## Додані функції + +- Майже всі PR оригінального it-tools, 192 мої +- 95% проблем оригінального it-tools +- Повний переклад інтерфейсу користувача на багато мов (перекладено Google) +- Багато [нових інструментів](https://sharevb-it-tools.vercel.app/about) +- Багато виправлень помилок та покращень +- Багато налаштувань (версія Docker) + +## Образы контейнерів + +[GitHub Container Registry](https://github.com/sharevb/it-tools/pkgs/container/it-tools): `ghcr.io/sharevb/it-tools:latest` + +[Docker Hub](https://hub.docker.com/r/sharevb/it-tools): `sharevb/it-tools:latest') + +## Використання у файлі Docker Compose + +```yml +services: + it-tools: + container_name: it-tools + image: sharevb/it-tools:latest + pull_policy: always + restart: unless-stopped + ports: + - 8080:8080 +``` + +## Фільтрація інструментів та додавання власного вмісту на домашню сторінку + +Ви можете додати власний вміст на домашню сторінку, змонтувавши `home.custom.md` в `/usr/share/nginx/html`. + +Ви можете фільтрувати доступні інструменти, змонтувавши `tools-filter.json` в `/usr/share/nginx/html`. + +## Внесок + +### Рекомендована налаштування IDE + +[VSCode](https://code.visualstudio.com/) з наступними розширеннями: + +- [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (і вимкнути Vetur) +- [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) +- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) +- [i18n Ally](https://marketplace.visualstudio.com/items?itemName=lokalise.i18n-ally) + +### Налаштування проекту + +```sh +pnpm install --ignore-scripts +``` + +### Компіляція та гаряче перезавантаження для розробки + +```sh +pnpm dev +``` + +### Перевірка типів, компіляція та мініфікація для продакшену + +```sh +pnpm build +``` + +### Запуск юніт-тестів з Vitest + +```sh +pnpm test +``` + +### Лінтинг з ESLint + +```sh +pnpm lint +``` + +### Створення нового інструменту + +Для створення нового інструменту є скрипт, який генерує шаблон. Просто виконайте: + +```sh +pnpm run script:create:tool my-tool-name +``` + +## Ліцензія + +Цей проект ліцензовано за [GNU GPLv3](LICENSE). diff --git a/docs/README.vi.md b/docs/README.vi.md new file mode 100644 index 0000000000..e4bada5554 --- /dev/null +++ b/docs/README.vi.md @@ -0,0 +1,114 @@ +## Thay đổi quan trọng cho hình ảnh container + +Vì hình ảnh cơ sở bây giờ là `nginx-unpriviledged`, container sẽ lắng nghe trên cổng **8080** chứ không phải 80. Vì vậy, bạn cần cập nhật ánh xạ cổng của mình, tức là từ `8080:80` thành `8080:8080`. + +Bạn có thể ghi đè cổng lắng nghe bằng biến môi trường `PORT` (tùy chọn docker `-e PORT=8888`). + +## PR được chào đón + +Đặc biệt cho cải tiến giao diện người dùng và bản dịch. Và cho bất kỳ điều gì khác. + +Muốn hỗ trợ fork IT Tools này: [Buy me a coffee](https://www.buymeacoffee.com/sharevb) + +## HTTPS được khuyến nghị + +Một số công cụ như mã hóa PGP dựa trên API WebCrypto chỉ có sẵn trong HTTPS/SSL. Ngoài ra, nếu bạn muốn sử dụng PWA, HTTPS là bắt buộc. + +Vì vậy, ngay cả trên các cài đặt nội bộ, bạn nên bật HTTPS bằng Let's Encrypt sử dụng DNS Challenge. + +## Đóng góp + +Cảm ơn tất cả những người đã đóng góp! + +[](https://github.com/sharevb/it-tools/graphs/contributors) + +## Phát triển trên Windows + +Nên sử dụng WSL2 để phát triển bằng VSCode trên Windows. Phát triển trực tiếp khó khăn (vì một số phụ thuộc). + +## Tính năng được thêm + +- Hầu hết [PR của it-tools gốc, 192 của tôi](https://github.com/CorentinTh/it-tools/pulls) +- 95% [vấn đề của it-tools gốc](https://github.com/CorentinTh/it-tools/issues) +- Dịch giao diện người dùng đầy đủ sang nhiều ngôn ngữ (dịch bởi Google) +- Nhiều [công cụ mới](https://sharevb-it-tools.vercel.app/about) +- Nhiều sửa lỗi và cải tiến +- Nhiều tùy chỉnh (phiên bản Docker) + +## Hình ảnh container + +[GitHub Container Registry](https://github.com/sharevb/it-tools/pkgs/container/it-tools): `ghcr.io/sharevb/it-tools:latest` + +[Docker Hub](https://hub.docker.com/r/sharevb/it-tools): `sharevb/it-tools:latest` + +## Sử dụng trong tệp Docker Compose + +```yml +services: + it-tools: + container_name: it-tools + image: sharevb/it-tools:latest + pull_policy: always + restart: unless-stopped + ports: + - 8080:8080 +``` + +## Lọc công cụ và thêm nội dung tùy chỉnh vào trang chủ + +Bạn có thể thêm nội dung tùy chỉnh vào trang chủ bằng cách gắn `home.custom.md` vào `/usr/share/nginx/html`. + +Bạn có thể lọc các công cụ có sẵn bằng cách gắn `tools-filter.json` vào `/usr/share/nginx/html`. + +## Đóng góp + +### Thiết lập IDE được khuyến nghị + +[VSCode](https://code.visualstudio.com/) với các tiện ích mở rộng sau: + +- [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (và tắt Vetur) +- [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) +- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) +- [i18n Ally](https://marketplace.visualstudio.com/items?itemName=lokalise.i18n-ally) + +### Thiết lập dự án + +```sh +pnpm install --ignore-scripts +``` + +### Biên dịch và Hot-Reload để phát triển + +```sh +pnpm dev +``` + +### Kiểm tra loại, biên dịch và minify cho sản xuất + +```sh +pnpm build +``` + +### Chạy kiểm thử đơn vị với Vitest + +```sh +pnpm test +``` + +### Lint với ESLint + +```sh +pnpm lint +``` + +### Tạo công cụ mới + +Để tạo công cụ mới, có một tập lệnh tạo mẫu. Chỉ cần chạy: + +```sh +pnpm run script:create:tool my-tool-name +``` + +## Giấy phép + +Dự án này được cấp phép theo [GNU GPLv3](LICENSE). diff --git a/docs/README.zh.md b/docs/README.zh.md new file mode 100644 index 0000000000..a1e498c101 --- /dev/null +++ b/docs/README.zh.md @@ -0,0 +1,114 @@ +## 容器镜像的重大更改 + +由于基础镜像现在是 `nginx-unpriviledged`,容器将监听端口 **8080** 而不是 80。因此需要更新端口映射,即从 `8080:80` 改为 `8080:8080`。 + +可以使用环境变量 `PORT` 覆盖监听端口(docker 选项 `-e PORT=8888`)。 + +## 欢迎贡献 + +特别欢迎UI改进和翻译,也欢迎其他任何贡献! + +支持这个fork: [Buy me a coffee](https://www.buymeacoffee.com/sharevb) + +## 建议使用HTTPS + +某些工具(如PGP加密)依赖仅在HTTPS/SSL下可用的WebCrypto API。此外,如果想使用PWA,也需要HTTPS。 + +因此,即使在内部安装时,也应使用Let's Encrypt的DNS Challenge启用HTTPS。 + +## 开发者 + +感谢所有贡献者! + +[](https://github.com/sharevb/it-tools/graphs/contributors) + +## 在Windows下开发 + +建议使用WSL2在VSCode中开发。直接开发比较麻烦(因为一些依赖)。 + +## 新增功能 + +- 几乎所有[原始it-tools的PR,192个我的](https://github.com/CorentinTh/it-tools/pulls) +- 95%的[原始it-tools问题](https://github.com/CorentinTh/it-tools/issues) +- 完整UI翻译(谷歌翻译) +- 许多[新工具](https://sharevb-it-tools.vercel.app/about) +- 许多错误修复和改进 +- 许多自定义(Docker版本) + +## 容器镜像 + +[GitHub Container Registry](https://github.com/sharevb/it-tools/pkgs/container/it-tools): `ghcr.io/sharevb/it-tools:latest` + +[Docker Hub](https://hub.docker.com/r/sharevb/it-tools): `sharevb/it-tools:latest` + +## 在Docker Compose中使用 + +```yml +services: + it-tools: + container_name: it-tools + image: sharevb/it-tools:latest + pull_policy: always + restart: unless-stopped + ports: + - 8080:8080 +``` + +## 过滤工具和添加自定义首页内容 + +您可以通过挂载 `home.custom.md` 到 `/usr/share/nginx/html` 来添加自定义内容到首页。 + +您可以通过挂载 `tools-filter.json` 到 `/usr/share/nginx/html` 来过滤可用的工具。 + +## 贡献 + +### 推荐的IDE设置 + +[VSCode](https://code.visualstudio.com/) 配合以下扩展: + +- [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)(禁用Vetur) +- [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) +- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) +- [i18n Ally](https://marketplace.visualstudio.com/items?itemName=lokalise.i18n-ally) + +### 项目设置 + +```sh +pnpm install --ignore-scripts +``` + +### 开发环境编译和热重载 + +```sh +pnpm dev +``` + +### 类型检查、编译和生产构建 + +```sh +pnpm build +``` + +### 使用Vitest运行单元测试 + +```sh +pnpm test +``` + +### 使用ESLint检查 + +```sh +pnpm lint +``` + +### 创建新工具 + +创建新工具有一个脚本生成模板,只需运行: + +```sh +pnpm run script:create:tool my-tool-name +``` + +## 许可证 + +本项目基于 [GNU GPLv3](LICENSE)。 diff --git a/env.d.ts b/env.d.ts index 18bdc8fe6d..deeb3729c8 100644 --- a/env.d.ts +++ b/env.d.ts @@ -2,6 +2,8 @@ ///