Разработческая документация для DripTable

Подготовка к разработке

Китайский язык | Английский

Основные знания перед началом работы

Что такое JSON Schema

1. JSON Schema сам по себе является типом данных, который позволяет четко описать структуру данных в формате JSON. Это описание JSON данных через другой JSON.
2. Официальная документация JSON Schema
3. Начало работы с JSON Schema

Что такое Lerna

1. Lerna — это инструмент управления, предназначенный для оптимизации рабочего процесса при работе с множеством пакетов кода, хранящихся в системах контроля версий git и менеджерах пакетов npm. Он позволяет управлять несколькими зависимыми пакетами внутри одного основного проекта, что решает проблему необходимости ручной синхронизации нескольких пакетов при выпуске новых версий.
2. Официальная документация Lerna
3. Начало работы с Lerna

Подготовка окружения

• Установите git, node, yarn, где версия node должна быть >=13.14.0, а версия yarn >=1.0.0

• Настройте источник NPM, если это необходимо.

  Настройка источника NPM

  npm config set registry https://registry.npmjs.com/

  Вход в NPM

  npm adduser (--registry=https://registry.npmjs.com/)

  Введите имя пользователя и пароль согласно запросам системы- Клонирование исходного кода

Запуск

1. Установка зависимостей

   lerna bootstrap

2. Сборка зависимых пакетов

   Для yarn

   yarn run build

   Для npm

   npm run build

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

   yarn start

4. Открытие браузера: переход по адресу http://localhost:8000.

Структура каталога- Обновление продолжается```

├── docs # Документация сайта │ ├── drip-table # Подстраница drip-table │ │ ├── changelog # Лог изменения версий │ │ │ └── index.md # Лог в формате markdown │ │ ├── functions # Подстраница функций drip-table │ │ ├── guide # Подстраница руководства drip-table │ │ ├── sample # Подстраница примеров drip-table │ │ ├── faq.md # Страница часто задаваемых вопросов drip-table в формате markdown │ │ └── index.md # Введение в документацию drip-table в формате markdown │ ├── drip-table-generator # Подстраница drip-table-generator │ │ ├── changelog # Лог изменения версий │ │ │ └── index.md # Лог в формате markdown │ │ ├── preview # Подстраница примеров drip-table-generator │ │ ├── faq.md # Страница часто задаваемых вопросов drip-table-generator в формате markdown │ │ └── index.md # Введение в документацию drip-table-generator в формате markdown │ ├── global-schema.ts # Глобальные схемы конфигураций для страницы примеров │ ├── index.css # CSS главной страницы сайта документации │ ├── index.md # Главная страница сайта документации в формате markdown │ ├── index.tsx # Главная страница сайта документации │ └── loading.js # Компонент загрузки сайта документации └── packages # Входные данные исходного кода ├── drip-table # Исходный код drip-table └── drip-table-generator # Исходный код генератора drip-table ## Разработка1. Создайте форк. 2. Создайте новую ветку с названием, отражающим изменения. 3. Внесите изменения и сделайте коммит. 4. Создайте запрос на слияние (Pull Request).

• Детали разработки drip-table см. в README.
• Детали разработки drip-table-generator см. в README.

Выпуск пакетов NPM

Если были внесены изменения в drip-table, то обновите package.json и changelog, затем выполните команду npm publish в директории drip-table.

Если были внесены изменения в drip-table-generator, то обновите package.json и changelog, затем выполните команду npm publish в директории drip-table-generator.

Если у вас нет прав доступа, обратитесь в официальную группу WeChat группа общения для получения необходимых прав, используйте команду npm owner add <username> <package-name>.

Опубликование сайта

Сборка и публикация

yarn run build:docs