dropapp

Readme

Вы только что нашли приложение Drop (первая версия Boxtribute — веб-приложения, которое позволяет организациям легко и справедливо находить, хранить и распределять пожертвованные товары нуждающимся людям). В настоящее время он находится в процессе замены на Boxtribute 2.0.

Dropapp изначально был разработан для Drop In The Ocean — норвежской неправительственной организации, которая работает в трёх лагерях беженцев по всей Греции. Среди других пользователей — Samos Volunteers, Europe Cares, Hermine, The Free ShopLiban, Межевропейская ассоциация помощи людям (IHA) и Movement on the Ground.

Мы усовершенствовали приложение, чтобы теперь оно размещалось централизованно, чтобы мы могли предлагать продукт гораздо большему количеству организаций, и постоянно работаем над улучшением системы и объединением организаций-доноров и дистрибьюторов друг с другом.

Если вы заинтересованы в участии в этом проекте, напишите нам по адресу [email protected]! Вы также можете посетить наш веб-сайт для получения более подробной информации о том, какая помощь нам нужна в этом проекте.

Подготовка к установке

• Установить Докер

• Установите PHP 8.2 или новее.

• Убедитесь, что у вас установлены расширения PHP mbstring , curl , mysql и xdebug . В Убунту:

   apt install php-curl php-mbstring php-mysql php-xdebug
  

Как мне настроиться?

0. Клонируйте этот репозиторий. Если вы используете Ubuntu, вам может потребоваться установить права на запись в папку шаблонов для Docker.

    git clone https://github.com/boxwise/dropapp
   chmod -R 777 dropapp/templates (not generally recommended - ToDo Fix bug for Ubuntu users) 
   

1. Сначала вам необходимо установить «composer» (мы предлагаем сделать его доступным по всему миру)

    curl -s https://getcomposer.org/installer | php
   mv composer.phar /usr/local/bin/composer
   

2. Затем вы можете установить необходимые зависимости, используя

    composer install
   

3. Чтобы настроить приложение, скопируйте /library/config.php.default и удалите расширение .default в имени файла. Затем заполните учетные данные Auth0 от клиента Auth0. Пожалуйста, проверьте docs/auth0.md для получения дополнительной информации об Auth0.

4. Мы предполагаем, что для запуска приложения у вас установлен Docker. Затем вы можете запустить:

    docker-compose up
   

   Альтернативно, вы можете запустить с помощью сервера разработки PHP.

    php -S localhost:8000 gcloud-entry.php 
   

5. Чтобы инициализировать базу данных в первый раз, вам следует запустить следующую команду для создания схемы:

    vendor/bin/phinx migrate -e development
   

   Начальное значение базы данных db/init.sql создается в версии 2 и копируется оттуда.

6. Если вы хотите дополнительно подключить пользователей из начального числа к auth0 и заполнить таблицу базы данных cms_usergroups_roles, откройте браузер и запросите http://localhost:8100/cron/reseed-auth0.php

Доступ к приложению

После запуска контейнеров докеров приложение становится доступным по адресу http://localhost:8100/.

После этого вы сможете войти в приложение, используя пароль Browser_tests и один из следующих адресов электронной почты:

• [email protected] (пользователь Бога)

BoxAid (все имеют доступ к одной базе под названием Лесбос):

• [email protected]
• [email protected]
• [email protected]
• склад[email protected]
• [email protected]
• [email protected]

BoxCare (объединено 3 базы — Салоники, Самос, Афины):

• [email protected]
• [email protected] (координатор на базах в Салониках и Самосе)
• [email protected] (волонтер на базах Салоники и Самос)
• координатор@thessaloniki.org
• координатор@samos.org
• координатор@athens.org
• волонтер @ Салоники.
• волонтер@samos.org
• волонтер@athens.org
• склад[email protected]
• [email protected]
• [email protected] (только для создания ярлыков)

Наши рекомендации по среде разработки

Большинство из нас используют VSCode в качестве редактора кода и инструментальную среду MySQL для доступа к базе данных.

Линтинг/Автоформатирование

Поэтому нам не нужно думать/спорить о соглашениях по коду, мы используем автоматический форматировщик кода php-cs-fixer.

CircleCI отклонит ваш запрос на включение, если есть какой-либо код, требующий исправлений при проверке.

Если вы используете VSCode, расширение vscode-php-cs-fixer будет предложено автоматически и при сохранении будет применено автоматическое форматирование.

Альтернативно, вы можете запустить

 php vendor/friendsofphp/php-cs-fixer/php-cs-fixer fix . --rules @PhpCsFixer

в корень вручную.

Отладка

Мы включили удаленную отладку XDebug в конфигурации Docker по умолчанию, чтобы вы могли пошагово выполнять свой код. Пожалуйста, запустите docker-compose up --build при следующем запуске сервера, чтобы обновить образ Docker.

Если вы используете VS Code, установите расширение PHP Debug и запустите конфигурацию «Прослушивание XDebug», после чего вы сможете установить точки останова в своем коде.

Имейте в виду, что перехватываются только точки останова, расположенные в строке с исполняемым кодом.

Отладка Для пользователей Linux

Контейнеры Docker, работающие в Linux, не могут преобразовать адрес host.docker.internal в IP-адрес. Чтобы использовать Xdebug в Linux, вам необходимо указать внутренний IP-адрес контейнера докеров в docker-compose.yaml . Чтобы узнать свой внутренний адрес докера, запустите

    docker inspect -f '{{range .NetworkSettings.Networks}}{{.Gateway}}{{end}}' 

Введите адрес в docker-compose.yaml здесь:

    environment:
        XDEBUG_CONFIG: remote_host=172.19.0.1 

База данных и миграции

Доступ из командной строки

Если вы хотите подключиться к серверу MySQL со своего хост-компьютера, вы можете сделать это, используя

 docker exec -it  mysql -u root -p

Сервер MySQL в вашем докер-контейнере также доступен через порт 9906 вашего локального хоста.

 mysql --host=127.0.0.1 --port=9906 -u root -p

Пароль для пользователя root для базы данных dropapp_dev — dropapp_root .

Доступ к рабочей среде MySQL

Большинство пользователей используют рабочую среду для доступа к базе данных MySQL. Чтобы установить соединение, вам необходимо ввести адрес localhost , например 127.0.0.1 для «Имени хоста» и 9906 для «Порта».

Миграции Финксов

Мы используем Phinx для миграции базы данных.

Для перехода на текущую версию базы данных запустите

    vendor/bin/phinx migrate

Чтобы создать прогон миграции

    vendor/bin/phinx create 

Он создает файл в db/migrations . Используйте этот файл для записи миграции базы данных.

Кипарис и тестирование

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

1. Установите Cypress через прямую загрузку
2. Установите переменную baseURL на свой локальный адрес, например localhost:8100 в cypress.json.
3. Установите переменную env auth0Domain для клиента Auth0 разработки, например boxtribute-dev.eu.auth0.com в cypress.json.
4. Откройте Cypress и этот репозиторий в Cypress.

Тесты Cypress завершаются неудачно из-за несинхронизированных пользователей с Auth0

Если тесты 2.4 и 2.9 не пройдены, проверьте

• если пользователь с [email protected] существует в Auth0 и удалите его
• если у [email protected] нет префикса «m»
• если у [email protected] нет назначенных ролей
• если testnewuser@ не существует.

Рекомендации по кипарису

Все тесты в cypress/integrations должны быть найдены и могут быть выполнены напрямую. При написании тестов старайтесь по возможности следовать этим рекомендациям:

• Избегайте дублирования вспомогательных функций в нескольких файлах! При тестировании одной и той же страницы в нескольких наборах тестов (файлах) существует тенденция копировать и вставлять весь файл, а затем переписывать тесты. Это приводит к дублированию кода вспомогательных функций. Вместо этого вспомогательные функции, необходимые в нескольких местах, должны быть определены в одном из файлов cypress/support - тогда они будут доступны глобально. Найдите подходящий по названию или создайте новый. В последнем случае не забудьте импортировать его в cypress/integrations/index.js . Избегайте создания разных имен файлов, поскольку это может привести к хаосу.
• Локальные вспомогательные функции, определенные в тестовых файлах, должны иметь функциональные и простые для понимания, а не технические имена. Это означает, что clickNewUserButton() лучше, чем clickElementByTypeAndTestId('button','new-user-button') .
• Помощники более общего назначения, такие как «clickElementByTypeAndTestId», при желании можно использовать в локальных вспомогательных функциях. Причина предпочтения функциональных имен заключается в повышении читаемости тестов.
• Текущая кодовая база не на 100% соответствует всему, что указано выше, но с этого момента она определенно поможет соответствующим образом организовать помощников по тестированию.

Известные проблемы с Cypress

Раньше мы сталкивались с тем, что тесты могут не пройти в CircleCI, но не в локальной среде. Основная причина этого в том, что Cypress обычно выполняет команды медленнее в локальной среде разработки. Поэтому несколько дополнительных рекомендаций при написании теста:

• Если вы хотите выполнить перенаправление, например, нажав кнопку или вкладку, добавьте утверждение после щелчка, например, URL-адреса cy.url().should('include', 'people_deactivated') . Благодаря этому утверждению cypress определенно будет ждать выполнения перенаправления.
• Только если вы используете cy.visit() вы можете быть уверены, что кипарисовый тест дождется полной загрузки страницы. Поэтому постарайтесь как можно больше перемещаться с помощью cy.visit() .

Примечания по настройке клиента Auth0

Если вы настраиваете нового клиента Auth0, нам необходим доступ к API управления Auth0. Чтобы сделать это

• В разделе «API» выберите Auth0 Management API, перейдите в «Machine to Machine Applications» и включите доступ.
• Предоставьте области для чтения/обновления/удаления/создания пользователей и пользователей_app_metadata.

Рекомендации по вкладу

Ты должен быть замечательным и добрым. Все остальное можно найти в наших правилах по вкладам.

С кем мне поговорить?

Напишите нам по адресу [email protected]!

Лицензия

Лицензионные права и ограничения см. в файле LICENSE (Apache 2.0).