Создание шаблона

Шаблоны являются отправной точкой для других пользователей. Они могут использовать их в качестве вдохновения и легко устанавливать в свои рабочие пространства. Шаблон состоит из одного или нескольких приложений, которые будут скопированы в желаемое рабочее пространство, если пользователь решит установить его. Пользователь также может просмотреть предварительный просмотр шаблона перед установкой.

Создайте свой собственный

Если вы хотите создать свой собственный шаблон, сначала вам нужно создать его в установке Baserow. Вам потребуется как минимум версия 1.1, так как она содержит функциональность экспорта, которая вам понадобится позже.

Первым шагом является создание нового пустого рабочего пространства. Название не имеет значения. Далее вы можете создать приложения, которые вы хотите включить в свой шаблон, в только что созданном рабочем пространстве.

Например, если вы хотите создать календарь контента, вы можете создать базу данных с названием Content Calendar, которая будет содержать три таблицы: Pipeline, Campaigns и Authors. После того как вы заполните все таблицы так, как вам нужно, вы можете перейти к следующему шагу, который заключается в экспорте вашего рабочего пространства для создания шаблона на его основе.

Экспорт приложений

Возможно экспортировать все приложения, находящиеся в рабочем пространстве. Когда пользователь устанавливает шаблон, этот экспорт используется для импорта приложений в желаемое рабочее пространство пользователя. Экспорт можно выполнить только через командную строку Baserow.

Прежде чем экспортировать приложение, вам нужно узнать ID вашего рабочего пространства. Вы увидите список всех ваших рабочих пространств, когда нажмете на название вашего рабочего пространства в боковой панели. Если навести курсор на рабочее пространство, появятся кликабельные три точки. При нажатии на них откроется контекстное меню, содержащее название этого рабочего пространства и число в скобках. Это число и есть ваш ID рабочего пространства.

Теперь, когда у вас есть ID рабочего пространства, содержащего ваш шаблон, вам нужно экспортировать его в формат JSON. Для этого вам потребуется доступ к командной строке вашей среды Baserow. Это может отличаться в зависимости от того, как установлена ваша среда. Вот несколько примеров:

Среда разработки

Внутри контейнера backend выполните следующую команду:

$ python src/baserow/manage.py export_workspace_applications YOUR_WORKSPACE_ID --indent

Среда Cloudron

Войдя в вашу среду Cloudron, вы можете получить доступ к терминалу вашего приложения Baserow. Там вы можете выполнить следующую команду для экспорта вашего приложения:

$ /app/code/env/bin/python /app/code/baserow/backend/src/baserow/manage.py export_workspace_applications YOUR_WORKSPACE_ID --indent --settings=cloudron.settings

Среда Ubuntu

Подключитесь к вашему серверу через SSH и выполните следующие команды:

$ cd /baserow
$ source backend/env/bin/activate
$ export DJANGO_SETTINGS_MODULE='baserow.config.settings.base'
$ export DATABASE_PASSWORD='yourpassword'
$ export DATABASE_HOST='localhost'
$ baserow export_workspace_applications YOUR_WORKSPACE_ID --indent

Экспорт

После выполнения команды управления вы заметите, что в вашей рабочей директории созданы два файла: workspace_YOUR_WORKSPACE_ID.json и workspace_YOUR_WORKSPACE_ID.zip. JSON-файл содержит структуру вашего экспорта, то есть базы данных, таблицы, поля, представления и строки. ZIP-файл содержит все загруженные файлы, связанные с экспортированными приложениями. Например, файл может быть включен в ZIP-файл, если таблица содержит поле файла и файлы были загружены.

Создание файла шаблона

Внутри директории backend/templates вы найдете все существующие шаблоны. Вам нужно создать новый JSON-файл здесь с таким же содержимым, как показано ниже. Вы можете заменить значения на что-то, соответствующее вашему шаблону. Мы сохраняем все шаблоны в формате JSON, чтобы все, кто сам хостит, также имели доступ к ним.

• name: Название шаблона, видимое пользователю.
• icon: Имя класса иконки, видимое пользователю (iconoir-{icon} или baserow-icon-{icon}).
• keyword: Невидимые ключевые слова будут использоваться только для улучшения поиска.
• categories: Категории, к которым относится шаблон.
• export: Значение экспорта должно содержать содержимое экспортированного JSON-файла после выполнения команды export_workspace_applications. Этот файл называется workspace_YOUR_WORKSPACE_ID.json.

{
    "baserow_template_version": 1,
    "name": "Календарь контента",
    "icon": "iconoir-user",
    "keywords": ["Пример", "Шаблон", "Для", "Поиска"],
    "categories": ["Тестовая категория 1"],
    "export": []
}

Экспорт также сгенерировал ZIP-файл, содержащий все связанные файлы. Этот файл называется workspace_YOUR_WORKSPACE_ID.zip. Он должен быть помещен в директорию backend/templates и иметь такое же имя, как и JSON-файл шаблона. Например, если шаблон называется applicant-tracker.json, ZIP-файл должен называться applicant-tracker.zip.

Синхронизация шаблона

Чтобы протестировать ваш шаблон, вам нужно выполнить команду управления sync_templates. Это обеспечит добавление копии шаблона в базу данных, чтобы пользователь мог увидеть быстрый предварительный просмотр.

Если все работает, вы можете создать запрос на слияние и поделиться своим шаблоном с сообществом.