From 6731e86830fc13940923898753f28a4bf126ac4d Mon Sep 17 00:00:00 2001 From: Ku6epXBOCTuK Date: Sun, 22 Feb 2026 09:54:39 +0500 Subject: [PATCH] docs: update README and LICENSE --- LICENSE | 21 +++++++++++++ README.md | 90 ++++++++++++++++++++++++++++++++++++++++++++----------- 2 files changed, 94 insertions(+), 17 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8861728 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Ku6epXBOCTuK + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index f7a0ae0..9c9528c 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,98 @@ -# sv +# Twitch Panels Creator -Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli). +🎨 Π’Π΅Π±-ΠΏΡ€ΠΈΠ»ΠΎΠΆΠ΅Π½ΠΈΠ΅ для создания ΠΈ настройки ΠΏΠ°Π½Π΅Π»Π΅ΠΉ для Twitch-ΠΊΠ°Π½Π°Π»ΠΎΠ². -## Creating a project +## 🌐 ДСмонстрация -If you're seeing this, you've probably already done this step. Congrats! +ΠŸΡ€ΠΈΠ»ΠΎΠΆΠ΅Π½ΠΈΠ΅ доступно ΠΏΠΎ адрСсу: https://ku6epxboctuk.github.io/twitch-panels/ + +## πŸ“‹ ОписаниС + +Twitch Panels Creator - это инструмСнт, ΠΊΠΎΡ‚ΠΎΡ€Ρ‹ΠΉ позволяСт стримСрам ΡΠΎΠ·Π΄Π°Π²Π°Ρ‚ΡŒ ΠΈ Π½Π°ΡΡ‚Ρ€Π°ΠΈΠ²Π°Ρ‚ΡŒ ΠΈΠ½Ρ„ΠΎΡ€ΠΌΠ°Ρ†ΠΈΠΎΠ½Π½Ρ‹Π΅ ΠΏΠ°Π½Π΅Π»ΠΈ для своих Twitch-ΠΊΠ°Π½Π°Π»ΠΎΠ². ΠŸΡ€ΠΈΠ»ΠΎΠΆΠ΅Π½ΠΈΠ΅ прСдоставляСт ΡƒΠ΄ΠΎΠ±Π½Ρ‹ΠΉ интСрфСйс для управлСния тСкстом, Ρ„ΠΎΠ½ΠΎΠ²Ρ‹ΠΌΠΈ изобраТСниями ΠΈ экспорта Π³ΠΎΡ‚ΠΎΠ²Ρ‹Ρ… ΠΏΠ°Π½Π΅Π»Π΅ΠΉ. + +## ✨ ΠžΡΠ½ΠΎΠ²Π½Ρ‹Π΅ возмоТности + +- βœ… Π‘ΠΎΠ·Π΄Π°Π½ΠΈΠ΅ ΠΈ Ρ€Π΅Π΄Π°ΠΊΡ‚ΠΈΡ€ΠΎΠ²Π°Π½ΠΈΠ΅ тСкстовых ΠΏΠ°Π½Π΅Π»Π΅ΠΉ с настройкой ΡˆΡ€ΠΈΡ„Ρ‚Π°, Ρ†Π²Π΅Ρ‚Π°, Ρ€Π°Π·ΠΌΠ΅Ρ€Π° ΠΈ выравнивания +- βœ… Π—Π°Π³Ρ€ΡƒΠ·ΠΊΠ° ΠΈ ΠΎΠ±Ρ€Π΅Π·ΠΊΠ° Ρ„ΠΎΠ½ΠΎΠ²Ρ‹Ρ… ΠΈΠ·ΠΎΠ±Ρ€Π°ΠΆΠ΅Π½ΠΈΠΉ с настройкой яркости ΠΈ контраста +- βœ… ΠŸΡ€Π΅Π΄ΠΏΡ€ΠΎΡΠΌΠΎΡ‚Ρ€ всСх ΠΏΠ°Π½Π΅Π»Π΅ΠΉ ΠΏΠ΅Ρ€Π΅Π΄ экспортом +- βœ… Экспорт ΠΏΠ°Π½Π΅Π»Π΅ΠΉ Π² PNG (320x100px) ΠΈΠ»ΠΈ массовый экспорт Π² ZIP-Π°Ρ€Ρ…ΠΈΠ² +- βœ… ΠŸΠΎΠ΄Π΄Π΅Ρ€ΠΆΠΊΠ° Ρ‚Π΅ΠΌΠ½ΠΎΠΉ ΠΈ свСтлой Ρ‚Π΅ΠΌΡ‹ + +## πŸ› οΈ Π’Π΅Ρ…Π½ΠΎΠ»ΠΎΠ³ΠΈΠΈ + +- **Frontend Framework:** Svelte 5 с SvelteKit +- **Π―Π·Ρ‹ΠΊ:** TypeScript +- **Π“Ρ€Π°Ρ„ΠΈΠΊΠ°:** Konva.js, Cropper.js +- **Π‘Π±ΠΎΡ€ΠΊΠ°:** Vite +- **Бтилизация:** CSS с CSS ΠΏΠ΅Ρ€Π΅ΠΌΠ΅Π½Π½Ρ‹ΠΌΠΈ +- **ВСстированиС:** Vitest, Playwright + +## πŸš€ Установка ΠΈ запуск + +### ΠšΠ»ΠΎΠ½ΠΈΡ€ΠΎΠ²Π°Π½ΠΈΠ΅ рСпозитория ```sh -# create a new project -npx sv create my-app +git clone https://github.com/ku6epxboctuk/twitch-panels.git +cd twitch-panels ``` -To recreate this project with the same configuration: +### Установка зависимостСй ```sh -# recreate this project -npx sv create --template minimal --types ts --install npm twitch-panels +npm install ``` -## Developing - -Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: +### Запуск сСрвСра Ρ€Π°Π·Ρ€Π°Π±ΠΎΡ‚ΠΊΠΈ ```sh npm run dev -# or start the server and open the app in a new browser tab +# ΠΈΠ»ΠΈ запуск сСрвСра ΠΈ ΠΎΡ‚ΠΊΡ€Ρ‹Ρ‚ΠΈΠ΅ прилоТСния Π² Π½ΠΎΠ²ΠΎΠΉ Π²ΠΊΠ»Π°Π΄ΠΊΠ΅ Π±Ρ€Π°ΡƒΠ·Π΅Ρ€Π° npm run dev -- --open ``` -## Building +## πŸ“¦ Π‘Π±ΠΎΡ€ΠΊΠ° -To create a production version of your app: +Для создания production-вСрсии прилоТСния: ```sh npm run build ``` -You can preview the production build with `npm run preview`. +Π’Ρ‹ ΠΌΠΎΠΆΠ΅Ρ‚Π΅ ΠΏΡ€Π΅Π΄Π²Π°Ρ€ΠΈΡ‚Π΅Π»ΡŒΠ½ΠΎ ΠΏΡ€ΠΎΡΠΌΠΎΡ‚Ρ€Π΅Ρ‚ΡŒ production-сборку с ΠΏΠΎΠΌΠΎΡ‰ΡŒΡŽ: -> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment. +```sh +npm run preview +``` + +## πŸ§ͺ ВСстированиС + +Запуск всСх тСстов: + +```sh +npm run test +``` + +Запуск тСстов с UI: + +```sh +npm run test:ui +``` + +Запуск тСстов с ΠΏΠΎΠΊΡ€Ρ‹Ρ‚ΠΈΠ΅ΠΌ: + +```sh +npm run test:coverage +``` + +## πŸ“„ ЛицСнзия + +Π­Ρ‚ΠΎΡ‚ ΠΏΡ€ΠΎΠ΅ΠΊΡ‚ распространяСтся ΠΏΠΎΠ΄ Π»ΠΈΡ†Π΅Π½Π·ΠΈΠ΅ΠΉ MIT. + +## 🀝 Π’ΠΊΠ»Π°Π΄ Π² ΠΏΡ€ΠΎΠ΅ΠΊΡ‚ + +Π’ΠΊΠ»Π°Π΄Ρ‹ ΠΏΡ€ΠΈΠ²Π΅Ρ‚ΡΡ‚Π²ΡƒΡŽΡ‚ΡΡ! Если Π²Ρ‹ Ρ…ΠΎΡ‚ΠΈΡ‚Π΅ внСсти свой Π²ΠΊΠ»Π°Π΄, поТалуйста, создайтС fork рСпозитория, создайтС Π²Π΅Ρ‚ΠΊΡƒ для вашСй Ρ„ΡƒΠ½ΠΊΡ†ΠΈΠΈ ΠΈ ΠΎΡ‚ΠΏΡ€Π°Π²ΡŒΡ‚Π΅ pull request. + +## πŸ“ž ΠšΠΎΠ½Ρ‚Π°ΠΊΡ‚Ρ‹ + +Если Ρƒ вас Π΅ΡΡ‚ΡŒ вопросы ΠΈΠ»ΠΈ прСдлоТСния, поТалуйста, создайтС issue Π² Ρ€Π΅ΠΏΠΎΠ·ΠΈΡ‚ΠΎΡ€ΠΈΠΈ ΠΏΡ€ΠΎΠ΅ΠΊΡ‚Π°.