docs: update README and LICENSE

This commit is contained in:
2026-02-22 09:56:27 +05:00
parent 27ac47de96
commit 6731e86830
2 changed files with 94 additions and 17 deletions
+73 -17
View File
@@ -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 в репозитории проекта.