yf-vue3-admin-base

👀 Онлайн-предпросмотр

Правила коммитов в Git

1. Основная ветвь (Master/Main):

   • Название: Обычно называется master или main ветвью.
   • Цель: Основная ветвь представляет стабильную версию проекта, которая всегда должна быть в состоянии для развертывания и представлять собой текущую версию для производства.

2. Ветвь разработки (Develop):

   • Название: Обычно называется develop ветвью.
   • Цель: Ветвь разработки используется для интеграции различных функций и исправлений. Все новые функции должны разрабатываться с этой ветви, и она должна служить основой для всех других ветвей функций.

3. Ветви функций (Feature):

   • Название: В названии ветвей функций обычно используется префикс feature/, за которым следует описание или имя конкретной функции.
   • Цель: Каждая новая функция должна разрабатываться в отдельной ветви функций, что позволяет изолировать разработку различных функций, облегчая отслеживание и управление. После завершения разработки ветвь функций должна быть объединена с ветвью разработки.

4. Ветви выпуска (Release):

   • Название: В названии ветвей выпуска обычно используется префикс release/, за которым следует номер версии или название выпуска. - Цель: Ветви выпуска используются для подготовки к выпуску новой версии.В этих ветвях можно обновлять номер версии, обновлять документацию, проводить окончательные тесты и исправления. После завершения подготовки ветвь выпуска должна быть объединена с основной ветвью и должна быть помечена соответствующим тегом для обозначения выпуска.

5. Ветви исправлений (Hotfix):

   • Название: В названии ветвей исправлений обычно используется префикс hotfix/, за которым следует описание исправления или номер проблемы.
   • Цель: Ветви исправлений используются для экстренных исправлений проблем в среде производства. Эти исправления должны проводиться в отдельной ветви, чтобы гарантировать, что они не повлияют на текущие функции разработки. После завершения исправления ветвь исправления должна быть объединена с основной ветвью и ветвью разработки.

ПРЕФИКС	ОПИСАНИЕ
feat:	Новая функциональность
fix:	Исправление ошибки
docs:	Изменение только в документации
style: 🌈	Изменение, не влияющее на смысл кода (пробелы, форматирование, отсутствие точек с запятой и т. д.)
refactor:	Изменение кода, не связанное с исправлением ошибок или добавлением функциональности
perf: 🚀	Изменение кода для улучшения производительности
chore:	Изменение процесса сборки или вспомогательных инструментов и библиотек (например, документации)
revert:↩️	Возврат коммита

Описание функций

1. Поддержка темной темы, настройки тем
2. Поддержка анимации отображения тем
3. Поддержка изменения структуры страниц
4. Поддержка перетаскивания вкладок
5. Поддержка адаптивного дизайна

Адаптивный дизайн

Левосторонний режим

Для настольных компьютеров

Для планшетов

Для мобильных устройств

Верхнесторонний режим

Для настольных компьютеров

Для планшетов

Для мобильных устройств

### Описание каталога

├─api                           # API запросы
├─assets                        # Статические ресурсы
│  └─icons                      # Иконки
├─components                    # Компоненты
│  ├─AppLink                    
│  └─SvgIcon
├─directive                     # Пользовательские директивы
├─enums                         # Перечисления
├─layout                        # ЛAYOUT структура
│  └─components                 
│      ├─AppMain                # Основной контент
│      ├─Navbar                 # Верхнее меню
│      │  └─components
│      ├─Settings               # Настройки
│      │  └─components
│      ├─Sidebar                # Сайдбар
│      │  └─components
│      ├─TagsView               # Теги
│      └─Tour                   # Путеводитель
├─plugins                       # Плагины
├─router                        # Маршрутизация
│  └─core                       # Основные настройки маршрутизации
├─store                         # Pinia менеджмент состояния
│  └─modules                    # Pinia модули
├─styles                        # Стили
├─typings                       # Объявления типов   
├─utils                         # Инструменты
└─views                         # Страницы
    ├─home
    ├─innerLink
    ├─nested
    │  └─level1
    │      └─level2
    ├─redirect                  # Компонент перенаправления
    ├─templateOne
    └─time

Пользовательский гайд### Установка зависимостей

yarn install

Запуск проекта

yarn run dev

Развертывание проекта

1. Сборка проекта

yarn run build

2. Загрузка проекта на сервер

3. Настройка сервера nginx

server {
        # Слушает порт 80
        listen 80;
        server_name  localhost;
        
        location / {
            # Например root /www/nginx/html/dist/
            root Путь к загруженным файлам;
            index index.html index.htm;
            try_files $uri $uri/ /index.html;
        }
    }

Группа для общения 🚀

QQ группа: 957226269

WeChat (после добавления в друзья приглашение в группу):

QQ группа: 957226269

WeChat (после добавления в друзья приглашение в группу):