theyworkforyou

他們為你工作

大家好，

這是為 TheyWorkForYou.com 網站提供支援的源代碼。它主要是用 PHP 編寫的，儘管也有一些用於資料庫載入和索引的 Perl 腳本。後端解析器程式碼是獨立的，可在 GitHub 上取得。您可以在 TheyWorkForYou 的解析器資訊頁面上閱讀更多相關信息

此發行版中的 TheyWorkForYou 原始碼是在 BSD 風格授權下發布的。粗略地說，這意味著您可以自由複製、使用、修改和重新分發程式碼或由程式碼產生的二進位檔案。允許商業或非商業用途。但是，我們不提供任何保證，並希望您未經我們許可不得使用我們的名稱。有關確切的法律信息，請參閱文件 LICENSE.md。

TheyWorkForYou 到底是什麼？

議員們在英國下議院所說的一切都記錄在一份名為《議事錄》的文件中； TheyWorkForYou 有助於理解這項重要的民主資源。它也包括上議院、蘇格蘭議會和北愛爾蘭議會的事務。

我到底要如何使用這個程式碼？

有關安裝問題，請參閱 INSTALL.md。

如果您有疑問，最好的提問地點是 mySociety TheyWorkForYou 電子郵件列表，網址為 https://groups.google.com/a/mysociety.org/forum/#!forum/theyworkforyou

使用 Docker 進行開發

您將需要最新版本的 Docker。

運行docker compose up [ -d ]將啟動環境。第一次運行此程式時，可能需要幾分鐘的時間，因為下載各種映像並在本地建立應用程式映像。

完成後，您應該可以在http://localhost:8000查看首頁。然而，預設建置不包含數據，因此請查看 INSTALL.md 以獲取有關下載和導入 Parlparse 數據（成員、辯論、投票等）的資訊。

您可以透過執行docker compose down來停止環境。新增-v將刪除可能正在使用的任何 Docker 卷，包括其所有資料。

DOCKER.md 有一些關於開發環境的更詳細的說明，以及一些有用的命令和更詳細的 Docker 特定設定說明。

若要在使用 WSL 的同時在 VS Code 中使用 xdebug，您需要在子系統的 IP 位址的子系統內設定 WSL_IP 的環境變數。

使用程式碼空間進行開發

透過選擇程式碼下拉清單（右上角）並啟動新的程式碼空間（或使用 GitHub CLI），在 Github 上啟動新的程式碼空間。

您也可以使用上面的徽章來使用具有基本資料量的預先建置。

這將設定 Docker 容器和環境。完成後，該網站的連結應該在終端面板的連接埠標籤中可用。

要填充最少量的數據，請執行scripts/quick-populate （約 1 小時）。

編譯靜態資源

如果您正在處理使用重新設計的頁面，則需要在變更後編譯靜態資源：

• script/watch-css

或者

• cd www/docs/style
• bundle exec compass compile用於一次性編譯，或bundle exec compass watch進行更改後重新編譯

程式碼格式化

script/lint將為 php 檔案執行 php-cs-fixer。

測試

TheyWorkForYou 包含一個使用 PHPunit 的測試套件。若要執行測試，請確保設定環境變數TWFY_TEST_DB_HOST 、 TWFY_TEST_DB_NAME 、 TWFY_TEST_DB_USER和TWFY_TEST_DB_PASS並包含測試資料庫的相關資訊。資料庫將在測試期間被剝離並重建，因此請確保它不是重要的副本。

您可能會發現，在某些版本的 PHPUnit 中，會引發程式碼覆蓋率報告的錯誤。如果是這種情況，由 Composer 安裝並位於/vendor/bin/phpunit版本應該可以正確運行。

建置狀態

致謝

感謝 Browserstack 讓我們在這個專案中使用他們基於 Web 的跨瀏覽器測試工具。