English | 简体中文

Поддержка экосистемы Claw

🦞GvaClaw

✨ Генерация базового фронтенд- и бэкенд-кода за одну минуту

Документация проекта

Онлайн-документация : https://www.gin-vue-admin.com

Инициализация

Видеоурок: от настройки окружения до деплоя

Руководство по разработке (авторы: LLemonGreen и Fann)

Сообщество

Маркетплейс плагинов

Свидетельство об авторских правах

Важные замечания

1. Проект полностью документирован: от начала разработки до деплоя — с подробными видеоуроками.

2. Для работы с проектом необходимы базовые знания Golang и Vue.

3. Вся необходимая информация есть в документации и туториалах, поэтому бесплатная техническая поддержка не предоставляется. При необходимости воспользуйтесь платной поддержкой.

4. При коммерческом использовании проекта соблюдайте лицензию Apache 2.0 и сохраняйте уведомления об авторских правах в коде и логах. Если вы планируете коммерческое использование (любая деятельность, приносящая доход) или вам необходимо удалить эти уведомления — приобретите лицензию.

1. Общее описание

1.1 О проекте

Gin-vue-admin — полнофункциональная платформа разработки с разделением фронтенда и бэкенда, построенная на Vue и Gin. Включает JWT-авторизацию, динамическую маршрутизацию, динамическое меню, авторизацию через Casbin, генератор форм, генератор кода и множество примеров — чтобы вы могли сосредоточиться на бизнес-логике.

Онлайн-демо: http://demo.gin-vue-admin.com

Тестовый логин: admin

Тестовый пароль: 123456

1.2 Руководство по участию в разработке

Привет! Спасибо, что используете gin-vue-admin.

Gin-vue-admin — это полноценный open-source фреймворк с разделением фронтенда и бэкенда, предназначенный для быстрого старта малых и средних проектов.

Развитие Gin-vue-admin невозможно без поддержки сообщества. Если вы хотите внести вклад в код или предложить улучшения — ознакомьтесь со следующими правилами.

1.2.1 Правила для Issue

• Issue используются только для сообщений об ошибках (Bug), запросов новых функций (Feature) и вопросов, связанных с дизайном. Прочие обращения могут быть закрыты без рассмотрения.

• Перед созданием Issue убедитесь, что аналогичный вопрос ещё не поднимался.

1.2.2 Правила для Pull Request

• Сначала сделайте fork репозитория в свой аккаунт. Не создавайте ветки напрямую в основном репозитории.

• Сообщение коммита должно иметь формат [имя файла]: описание, например README.md: fix xxx bug.

• При исправлении ошибки добавьте описание в PR.

• Для слияния кода требуется участие двух мейнтейнеров: один проводит review и ставит approve, второй повторно проверяет и подтверждает слияние.

2. Инструкция по использованию

2.1 Серверная часть (server)

Откройте директорию server в Goland или другом редакторе. Не открывайте корневую директорию gin-vue-admin целиком.

# Клонировать репозиторий
git clone https://github.com/flipped-aurora/gin-vue-admin.git
# Перейти в директорию server
cd server

# Использовать go mod и установить зависимости
go generate

# Запустить
go run . 

2.2 Фронтенд (web)

# Перейти в директорию web
cd web

# Установить зависимости
npm install

# Запустить фронтенд
npm run serve

2.3 Автоматическая API-документация через Swagger

2.3.1 Установка Swagger

2.3.2 Генерация API-документации

cd server
swag init

После выполнения команды в директории server обновятся файлы docs.go, swagger.json и swagger.yaml в папке docs. После запуска Go-сервера документация будет доступна по адресу http://localhost:8888/swagger/index.html.

2.4 Рабочее пространство VSCode

2.4.1 Разработка

Откройте файл рабочего пространства gin-vue-admin.code-workspace из корневой директории в VSCode. На боковой панели появятся три виртуальные директории: backend, frontend, root.

2.4.2 Запуск и отладка

В разделе «Запуск и отладка» доступны три задачи: Backend, Frontend, Both (Backend & Frontend). Запуск Both (Backend & Frontend) одновременно стартует фронтенд и бэкенд.

2.4.3 Настройки

В файле конфигурации рабочего пространства есть поле go.toolsEnvVars — переменные окружения для встроенных Go-инструментов VSCode. В системах с несколькими версиями Go можно указать нужную через поля gopath и go.goroot.