Если вы хотите внести свой вклад в Baserow, вам нужно настроить окружение разработки на вашем локальном компьютере. Лучший способ сделать это — через docker-compose
, чтобы вы могли запустить приложение с минимальными усилиями.
Если вы знакомы с git и docker-compose, выполните следующие команды, чтобы запустить окружение разработки Baserow локально, в противном случае начните с раздела "Установка требований" ниже.
$ git clone --branch develop https://gitlab.com/baserow/baserow.git
# Наш скрипт ./dev.sh обертывает docker-compose, устанавливая правильные переменные окружения,
# чтобы обеспечить горячую перезагрузку кода.
$ ./dev.sh
# Выполните ./dev.sh help для получения дополнительной информации.
$ ./dev.sh help
Если вы еще не установили docker и docker-compose на вашем компьютере, вы можете сделать это, следуя инструкциям на https://docs.docker.com/desktop/ и https://docs.docker.com/compose/install/.
Версия Docker 19.03 является минимально необходимой для сборки Baserow. Однако настоятельно рекомендуется установить последнюю доступную версию Docker. Проверьте, что ваш Docker обновлен, выполнив команду
docker -v
.
Вам также потребуется установленный git, который можно установить, следуя инструкциям на https://www.linode.com/docs/development/version-control/how-to-install-git-on-linux-mac-and-windows/.
После завершения установки всех необходимых программных обеспечений вы должны быть able to run следующие команды в вашем терминале.
$ docker -v
Docker version 20.10.6, build 370c289
$ docker-compose -v
docker-compose version 1.26.2, build eefe0d31
$ git --version
git version 2.24.3 (Apple Git-128)
Если все команды возвращают что-то подобное тому, что описано в примере, тогда вы готовы продолжать!
Если у вас возникнут проблемы с запуском окружения разработки, не стесняйтесь обращаться к нам через форму на https://baserow.io/contact.
Для примера я создал директорию в своей домашней папке под названием baserow
. Вы, конечно, можете следовать шагам в любой директории, но в этом руководстве я буду предполагать, что рабочая директория — ~/baserow
.
Сначала нам нужно клонировать репозиторий. Выполните следующие команды, чтобы клонировать ветку master. Если вы не знакомы с git clone, это скачает копию кода Baserow на ваш компьютер.
$ cd ~/baserow
$ git clone --branch master https://gitlab.com/baserow/baserow.git
Cloning into 'baserow'...
...
$ cd baserow
Теперь, когда у нас есть копия репозитория и мы перешли в новую директорию baserow
, мы можем запустить контейнеры. Вам нужно выполнить команду docker-compose с использованием файла docker-compose.yml
. Это может занять некоторое время, так как образы должны быть собраны с нуля.
$ ./dev.sh
Building backend
...
Starting db ... done
Starting redis ... done
Starting backend ... done
Starting web-frontend ... done
Ваше окружение разработки теперь запущено, база данных была автоматически мигрирована, а шаблоны Baserow были синхронизированы. Теперь вы можете посетить http://localhost:3000, чтобы зарегистрироваться и войти в свой Baserow.
Контейнер backend Baserow предоставляет REST API. Найдите спецификацию API для вашей локальной версии Baserow по адресу http://localhost:8000/api/redoc/. Чтобы проверить, что он работает правильно, когда вы посетите http://localhost:8000/api/workspaces/ в браузере, вы должны увидеть ошибку "Authentication credentials were not provided.", так как JWT не был предоставлен.
Окружение разработки состоит из нескольких контейнеров Docker, см.:
Если вы используете ./dev.sh
, по умолчанию он попытается открыть вкладки в вашем терминале и подключиться к запущенным контейнерам Baserow. В противном случае вы можете сделать это вручную, выполнив следующие команды:
$ # Выполните команды ниже, чтобы подключиться к различным частям Baserow
$ docker attach backend
$ docker attach celery
$ docker attach web-frontend
Когда вы подключены, вы можете нажать CTRL-C, чтобы завершить основной процесс текущего контейнера. Однако, в отличие от обычных контейнеров Docker, этот контейнер не завершится немедленно, а вместо этого предложит вам bash-терминал. В этом терминале вы можете выполнить любые административные команды или проверить состояние контейнеров. Просто нажмите стрелку вверх и пройдитесь по истории bash-терминала контейнера, чтобы получить исходную команду для перезапуска основного процесса контейнера.
Ниже приведен быстрый пример некоторых наиболее распространенных полезных операций и команд:
$ # Просмотреть логи
$ docker-compose logs
$ # Миграция
$ ./dev.sh run backend manage migrate
$ # Перезапуск и сборка
$ ./dev.sh restart --build
Контейнеры web-frontend и backend должны продолжать работать во время разработки. Они также отслеживают изменения файлов и обновляются автоматически, поэтому вам не нужно беспокоиться о перезагрузке. Внесите какие-нибудь изменения сами. Вы должны увидеть результат сразу же.
Для дальнейшего чтения о том, как работать с контейнерами Docker и Django, ознакомьтесь со следующими ресурсами:
Вы можете оставить комментарий после Вход в систему
Неприемлемый контент может быть отображен здесь и не будет показан на странице. Вы можете проверить и изменить его с помощью соответствующей функции редактирования.
Если вы подтверждаете, что содержание не содержит непристойной лексики/перенаправления на рекламу/насилия/вульгарной порнографии/нарушений/пиратства/ложного/незначительного или незаконного контента, связанного с национальными законами и предписаниями, вы можете нажать «Отправить» для подачи апелляции, и мы обработаем ее как можно скорее.
Опубликовать ( 0 )