theyworkforyou

Mereka Bekerja Untuk Anda

Halo semuanya,

Ini adalah kode sumber yang mendukung situs TheyWorkForYou.com. Ini sebagian besar ditulis dalam PHP, meskipun ada juga beberapa skrip Perl untuk memuat dan mengindeks database. Kode parser backend terpisah dan tersedia di GitHub. Anda dapat membaca lebih lanjut tentang ini di halaman info parser TheyWorkForYou

Kode sumber TheyWorkForYou dalam distribusi ini dirilis di bawah lisensi gaya BSD. Secara kasar, ini berarti Anda bebas menyalin, menggunakan, memodifikasi, dan mendistribusikan kembali kode atau binari yang dibuat dari kode tersebut. Penggunaan komersial atau non-komersial diperbolehkan. Namun, kami menyangkal garansi, dan mengharapkan Anda untuk tidak menggunakan nama kami tanpa izin kami. Lihat file LICENSE.md untuk informasi hukum yang tepat.

Apa sih TheyWorkForYou itu?

Segala sesuatu yang dikatakan anggota parlemen di House of Commons Inggris dicatat dalam sebuah dokumen bernama Hansard; TheyWorkForYou membantu memahami sumber daya demokrasi yang penting ini. Ini juga mencakup hal-hal dari House of Lords, Parlemen Skotlandia, dan Majelis Irlandia Utara.

Bagaimana cara menggunakan kode ini?

Lihat INSTALL.md untuk pertanyaan instalasi.

Jika Anda memiliki pertanyaan, tempat terbaik untuk bertanya adalah daftar email mySociety TheyWorkForYou di https://groups.google.com/a/mysociety.org/forum/#!forum/theyworkforyou

Berkembang dengan Docker

Anda memerlukan Docker versi terbaru.

Menjalankan docker compose up [ -d ] akan memulai lingkungan. Pertama kali Anda menjalankan ini mungkin memerlukan waktu beberapa menit karena berbagai gambar diunduh dan gambar aplikasi dibuat secara lokal.

Setelah selesai, Anda akan dapat melihat halaman depan di http://localhost:8000 . Namun build default tidak berisi data, jadi lihat INSTALL.md untuk informasi tentang mendownload dan mengimpor data Parlparse (anggota, debat, suara, dll).

Anda dapat menghentikan lingkungan dengan menjalankan docker compose down . Menambahkan -v akan menghapus semua volume Docker yang mungkin digunakan, termasuk semua datanya.

DOCKER.md memiliki beberapa catatan lebih rinci tentang lingkungan pengembangan, bersama dengan beberapa perintah berguna dan catatan pengaturan khusus Docker yang lebih rinci.

Untuk menggunakan xdebug di VS Code saat menggunakan WSL, Anda harus menyetel variabel lingkungan WSL_IP dalam subsistem alamat IP subsistem.

Berkembang dengan ruang kode

Mulai ruang kode baru di Github dengan memilih tarik-turun Kode (kanan atas), dan mulai ruang kode baru (atau gunakan GitHub CLI).

Anda juga dapat menggunakan badge di atas untuk menggunakan prebuild dengan jumlah data dasar.

Ini akan mengatur container dan lingkungan Docker. Setelah selesai, tautan ke situs tersebut seharusnya tersedia di tab port pada panel terminal.

Untuk mengisi dengan jumlah data minimal, jalankan scripts/quick-populate (sekitar 1 jam).

Menyusun Aset Statis

Jika Anda sedang mengerjakan halaman yang menggunakan desain ulang, Anda perlu mengkompilasi aset statis setelah perubahan:

• script/watch-css

atau

• cd www/docs/style
• bundle exec compass compile untuk kompilasi satu kali atau bundle exec compass watch untuk mengkompilasi ulang jika ada perubahan

Pemformatan kode

script/lint akan menjalankan php-cs-fixer untuk file php.

Pengujian

TheyWorkForYou menyertakan rangkaian pengujian, menggunakan PHPunit. Untuk menjalankan pengujian, pastikan variabel lingkungan TWFY_TEST_DB_HOST , TWFY_TEST_DB_NAME , TWFY_TEST_DB_USER dan TWFY_TEST_DB_PASS disetel dan berisi informasi yang relevan untuk database pengujian Anda. Basis data akan dilucuti dan dibangun kembali selama pengujian, jadi pastikan itu bukan salinan penting.

Anda mungkin menemukan bahwa di beberapa versi PHPUnit muncul kesalahan terkait laporan cakupan kode. Jika demikian, versi yang diinstal oleh Composer dan terletak di /vendor/bin/phpunit akan berjalan dengan benar.

Membangun Status

Ucapan Terima Kasih

Terima kasih kepada Browserstack yang mengizinkan kami menggunakan alat pengujian lintas browser berbasis web untuk proyek ini.