feat: update readme

2025-11-11 00:19:19 +03:00
parent 3345d4eb94
commit 1361fea993
1 changed files with 82 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,82 @@
+# TeleCart
+
+[![License](https://img.shields.io/badge/license-GPL--3.0-blue.svg)](LICENSE)
+[![PHP Version](https://img.shields.io/badge/PHP-%3E%3D5.4.0-blue.svg)](https://php.net)
+[![Vue.js](https://img.shields.io/badge/Vue.js-3.5.22-4FC08D?logo=vue.js&logoColor=white)](https://vuejs.org)
+[![Docker](https://img.shields.io/badge/Docker-Ready-2496ED?logo=docker&logoColor=white)](docker-compose.yaml)
+[![OpenCart](https://img.shields.io/badge/OpenCart-Module-FF6B35?logo=opencart)](https://www.opencart.com)
+
+Telegram магазин на базе OpenCart. Позволяет создать полноценный интернет-магазин в виде Telegram Mini App.
+
+## 🚀 Возможности
+
+- 📱 Telegram Mini App интерфейс
+- 🛒 Полноценная корзина и оформление заказов
+- 🎨 Адаптивный дизайн с поддержкой темной/светлой темы
+- 📊 Административная панель для управления настройками
+- 🔍 Поиск и фильтрация товаров
+- 📦 Интеграция с OpenCart
+
+## 🛠 Технологии
+
+- **Backend**: PHP (OpenCart), Composer
+- **Frontend**: Vue.js 3, Vite, Tailwind CSS, Pinia
+- **Инфраструктура**: Docker, Docker Compose
+- **Тестирование**: PHPUnit, Vitest
+
+## 📦 Структура проекта
+
+```
+telecart/
+├── frontend/
+│   ├── admin/      # Административная панель
+│   └── spa/        # Telegram Mini App
+├── module/         # Модуль OpenCart
+├── docker/         # Docker конфигурации
+└── src/            # Исходный код OpenCart
+```
+
+## 🚀 Быстрый старт
+
+### Требования
+
+- Docker и Docker Compose
+- PHP >= 5.4.0
+- Node.js >= 20.19.0 или >= 22.12.0
+
+### Установка
+
+```bash
+# Клонировать репозиторий
+git clone git@github.com:telecart-labs/telecart.git
+cd telecart
+
+# Настроить проект
+make setup
+
+# Запустить в режиме разработки
+make dev
+```
+
+### Доступные команды
+
+- `make setup` - Первоначальная настройка проекта
+- `make start` - Запустить контейнеры
+- `make stop` - Остановить контейнеры
+- `make dev` - Запустить в режиме разработки
+- `make dev-admin` - Запустить админ-панель в режиме разработки
+- `make test` - Запустить тесты
+- `make lint` - Проверить код линтером
+
+## 📝 Лицензия
+
+Проект распространяется под лицензией [GPL-3.0](LICENSE).
+
+## 🤝 Вклад в проект
+
+Мы приветствуем вклад в развитие проекта! Пожалуйста, создавайте issue и pull request'ы.
+
+## 📄 Документация
+
+Дополнительная документация находится в папке [`docs/`](docs/).
+