Files
hereconnect/README.md
T

74 lines
3.8 KiB
Markdown
Raw Normal View History

2024-11-21 01:28:15 +02:00
# Monorepo for QR Code Communication Platform
Этот репозиторий содержит код для платформы, предоставляющей возможность создания и использования QR-кодов для взаимодействия между пользователями. Репозиторий организован как монорепозиторий для упрощения управления проектом.
2024-11-21 08:46:06 +02:00
# Тестовый стенд:
[https://hereconnect.condev.ru/](https://hereconnect.condev.ru/) автоматически собирается с ветки main
2024-11-21 01:28:15 +02:00
## Структура репозитория
```plaintext
monorepo/
├── apps/ # Приложения
│ └── frontend/ # Основное фронтенд-приложение
│ ├── src/ # Исходный код
│ ├── public/ # Публичные файлы
│ ├── package.json # Локальные зависимости приложения
│ └── vite.config.ts # Конфигурация Vite
├── packages/ # Общие библиотеки (пока пусто)
├── services/ # Микросервисы (пока пусто)
├── .gitea/ # Конфигурации CI/CD
│ └── workflows/ # Workflows для Gitea Actions
│ └── deploy.yaml # Сценарий деплоя
├── package.json # Корневой package.json
└── README.md # Документация
```
# Monorepo for QR Code Communication Platform
Этот репозиторий содержит код для платформы, предоставляющей возможность создания и использования QR-кодов для взаимодействия между пользователями. Репозиторий организован как монорепозиторий для упрощения управления проектом.
## Приложения
- **Frontend**: Основное фронтенд-приложение, предоставляющее пользовательский интерфейс для создания QR-кодов, настройки взаимодействия и управления уведомлениями.
## Общие библиотеки
Папка `packages` предназначена для размещения библиотек, которые могут быть переиспользованы в разных приложениях. На данный момент она пустая.
## Микросервисы
Папка `services` предназначена для размещения микросервисов, таких как обработка уведомлений или работа с QR-кодами. На данный момент она пустая.
## Установка и запуск
### 1. Установка зависимостей
Используйте [npm](https://www.npmjs.com/) для установки зависимостей:
```bash
npm install
```
### 2. Запуск локального сервера для разработки
```bash
npm run --workspace=apps/frontend dev
```
### 3. Сборка приложения
Для сборки фронтенд-приложения:
```bash
npm run --workspace=apps/frontend build
```
## CI/CD
Настроены workflows для Gitea Actions:
- **deploy.yaml**: Сценарий деплоя приложения.
## Используемые технологии
- **Frontend**: Vue 3, Vite, PrimeVue, TailwindCSS.
- **Инструменты**: TypeScript, npm, Gitea Actions.