Настройка IntelliJ

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

Это руководство предполагает, что у вас есть базовое понимание git, python, virtualenvs, postgres и командных строк.

1. Сначала клонируйте свежую копию Baserow: git clone git@gitlab.com:baserow/baserow.git
2. cd baserow
3. ./config/intellij/apply_standard_baserow_intellij_config.sh
   1. Введите Y и нажмите Enter, чтобы применить стандартную конфигурацию Baserow
4. Откройте IntelliJ и на экране "Добро пожаловать в IntelliJ IDEA" нажмите кнопку "Открыть" и откройте папку baserow, которую вы склонировали выше.
5. Убедитесь, что у вас установлен и включен плагин Python для IntelliJ.
6. Теперь мы создадим виртуальное окружение Python и настроим IntelliJ для его использования при запуске тестов и линтеров:
   1. Выберите место для вашего виртуального окружения, рекомендуется хранить его отдельно от папки с исходным кодом Baserow, чтобы IntelliJ не искало и не индексировало его.
   2. Создайте виртуальное окружение: python3 -m venv venv или virtualenv -p python venv
   3. Активируйте виртуальное окружение: source venv/bin/activate (будет отличаться в зависимости от вашей оболочки)
   4. Выполните which pip и убедитесь, что вывод этой команды теперь указывает на bin в вашем новом виртуальном окружении
   5. Перейдите в директорию с исходным кодом Baserow: cd path/to/your/baserow
   6. Установите все требования Python Baserow в ваше виртуальное окружение:

      pip install -r backend/requirements/dev.txt
      pip install -r backend/requirements/base.txt
   7. Теперь вернитесь в IntelliJ, нажмите F4 или щелкните правой кнопкой мыши на верхнем уровне папки baserow и выберите Настройки модуля:
      1. Убедитесь, что SDK модуля backend установлено на ваше новое виртуальное окружение Python.
      2. Скорее всего, будет существующее виртуальное окружение SDK Python 3.8 (baserow), которое отображается красным цветом. Сначала удалите его.
      3. Затем вам скорее всего потребуется добавить его как новое SDK, перейдя по пути
         1. F4 → SDK
         2. нажмите +
         3. Добавить новое SDK Python
         4. Существующий интерпретатор
         5. Найдите и выберите исполняемый файл bin/python вашего виртуального окружения
         6. Назовите это новое SDK Python 3.8 (baserow), чтобы не сделать случайных изменений в файле backend.iml:
7. Установите и запустите локальную базу данных PostgreSQL:
   1. https://www.postgresql.org/docs/11/tutorial-install.html
   2. Измените порт по умолчанию PostgreSQL, иначе он будет конфликтовать при запуске с Baserow (стандартная конфигурация IntelliJ в репозитории предполагает, что ваша тестовая база данных работает на порту 5430)
      1. https://stackoverflow.com/questions/187438/change-pgsql-port
   3. Создайте пользователя Baserow с именем baserow и паролем baserow и предоставьте ему права на создание баз данных

      1. https://medium.com/coding-blocks/creating-user-database-and-adding-access-on-postgresql-8bfcd2f4a91e

         CREATE USER baserow WITH ENCRYPTED PASSWORD 'baserow';
         ALTER USER baserow CREATEDB;
   4. Возможно, вам также придется выполнить pip install psycopg2-binary или sudo apt install postgresql-devel
8. Теперь вы должны иметь возможность запустить тесты Python backend, попробуйте запустить backend/tests/baserow/core/test_core_models.py, например.
9. Теперь давайте настроим вашу среду разработки frontend, перейдя в директорию baserow/web-frontend
10. Теперь выполните yarn install (если у вас нет yarn, установите менеджер версий Node.js, такой как nvm и следуйте инструкциям по установке Yarn). См. baserow/docs/installation/supported.md, чтобы определить поддерживаемую версию Node.js.
11. Выберите "Доверять проекту", если увидите всплывающее окно IntelliJ после выполнения yarn install
12. Откройте настройки, найдите и откройте категорию Node.js и NPM и убедитесь, что интерпретатор Node указывает на желаемый исполняемый файл Node
13. Подтвердите, что вы можете запустить юнит-тест frontend из IntelliJ
14. Откройте настройки и найдите eslint, убедитесь, что вы переключились на Ручную конфигурацию ESLint, установили пакет ESlint на подпапку eslint в node_modules, созданной предыдущим yarn install (baserow/web-frontend/node_modules/eslint)

Рекомендуемые плагины

1. https://plugins.jetbrains.com/plugin/14321-blackconnect
   1. Автоматически запускает black над измененными файлами. Настройте демон blackd, который запускается при старте, для минимального трения.
2. Database Navigator
3. IntelliVue
4. Key Promoter X
5. Vue.js