dropapp

Baca saya

Anda baru saja menemukan Drop App (versi pertama Boxtribute - sebuah aplikasi web, yang memudahkan organisasi untuk mencari, menyimpan, dan mendistribusikan barang sumbangan kepada orang-orang yang membutuhkan dengan cara yang adil dan bermartabat). Saat ini sedang dalam proses digantikan oleh Boxtribute 2.0.

Dropapp awalnya dikembangkan untuk Drop In The Ocean - sebuah LSM Norwegia yang bekerja di tiga kamp pengungsi di seluruh Yunani. Pengguna lainnya termasuk Samos Volunteers, Europe Cares, Hermine, The Free Shop Lebanon, Intereuropean Human Aid Association (IHA) dan Movement on the Ground.

Kami telah mengembangkan aplikasi ini agar dapat dihosting secara terpusat sehingga kami dapat menawarkan produk ke lebih banyak organisasi, dan terus bekerja untuk meningkatkan sistem dan menghubungkan organisasi donor dan distributor satu sama lain.

Jika Anda tertarik menjadi bagian dari proyek ini, kirimkan email kepada kami di [email protected]! Anda juga dapat mengunjungi situs web kami untuk rincian lebih lanjut tentang jenis bantuan yang kami perlukan dalam proyek ini.

Persiapan Instalasi

• Instal Docker

• Instal PHP 8.2 atau lebih baru.

• Pastikan Anda telah menginstal ekstensi mbstring , curl , mysql dan xdebug PHP. Di Ubuntu:

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

Bagaimana cara menyiapkannya?

0. Kloning repo ini. Jika Anda menjalankan Ubuntu, Anda mungkin perlu mengatur izin menulis ke folder templat untuk Docker.

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

1. Anda harus menginstal 'komposer' terlebih dahulu (kami menyarankan agar tersedia secara global)

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

2. Anda dapat menginstal dependensi yang diperlukan kemudian menggunakan

    composer install
   

3. Untuk mengonfigurasi aplikasi, salin /library/config.php.default dan hapus .default di nama file. Kemudian isi kredensial Auth0 dari klien Auth0. Silakan periksa docs/auth0.md untuk informasi lebih lanjut mengenai Auth0.

4. Untuk menjalankan aplikasi, kami berasumsi Anda telah menginstal Docker. Anda kemudian dapat menjalankan:

    docker-compose up
   

   Alternatifnya, Anda dapat menjalankannya menggunakan server pengembangan PHP

    php -S localhost:8000 gcloud-entry.php 
   

5. Untuk menginisialisasi database pertama kali, Anda harus menjalankan perintah ini untuk membuat skema:

    vendor/bin/phinx migrate -e development
   

   Seed database db/init.sql dibuat di v2 dan disalin dari sana.

6. Jika Anda juga ingin menghubungkan pengguna dari seed ke auth0 dan mengisi tabel db cms_usergroups_roles lalu buka browser dan minta http://localhost:8100/cron/reseed-auth0.php

Mengakses aplikasi

Setelah wadah buruh pelabuhan berjalan, aplikasi dapat diakses di http://localhost:8100/

Setelah ini, Anda seharusnya bisa masuk ke aplikasi menggunakan kata sandi Browser_tests dan salah satu email berikut:

• [email protected] (Pengguna Tuhan)

BoxAid (semua memiliki akses ke satu basis yang disebut Lesvos):

• [email protected]
• [email protected]
• [email protected]
• [email protected]
• [email protected]
• [email protected]

BoxCare (ada 3 basis yang terkait - Thessaloniki, Samos, Athena):

• [email protected]
• [email protected] (Koordinator di pangkalan Thessaloniki dan Samos)
• [email protected] (Relawan di pangkalan Thessaloniki dan Samos)
• [email protected]
• [email protected]
• [email protected]
• sukarelawan@thessaloniki.
• [email protected]
• [email protected]
• [email protected]
• [email protected]
• [email protected] (hanya untuk pembuatan label)

Rekomendasi lingkungan pengembang kami

Sebagian besar dari kita menggunakan VSCode sebagai editor kode dan meja kerja MySQL untuk akses database.

Linting / Pemformatan otomatis

Jadi kita tidak perlu memikirkan/berdebat mengenai konvensi kode, kita menggunakan pemformat kode otomatis php-cs-fixer.

CircleCI akan menggagalkan Permintaan Tarik Anda jika ada kode yang memerlukan perbaikan linting.

Jika Anda menggunakan VSCode, ekstensi vscode-php-cs-fixer akan disarankan secara otomatis dan menerapkan format otomatis saat disimpan.

Alternatifnya, Anda bisa lari

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

di root secara manual.

Men-debug

Kami telah mengaktifkan debugging jarak jauh XDebug di konfigurasi Docker default, sehingga Anda dapat menelusuri kode Anda. Silakan jalankan docker-compose up --build saat berikutnya Anda memulai server untuk memperbarui image buruh pelabuhan Anda.

Jika Anda menggunakan VS Code, jika Anda menginstal ekstensi PHP Debug dan memulai konfigurasi 'Dengarkan XDebug', Anda kemudian dapat mengatur breakpoint dalam kode Anda.

Perlu diketahui bahwa hanya breakpoint yang tertangkap yang berada dalam satu baris dengan kode yang dapat dieksekusi.

Debugging Untuk pengguna linux

Kontainer Docker yang berjalan di linux tidak dapat menyelesaikan alamat host.docker.internal ke alamat ip. Untuk menggunakan Xdebug di linux Anda harus menentukan alamat ip internal wadah buruh pelabuhan di docker-compose.yaml . Untuk mengetahui alamat buruh pelabuhan internal Anda, jalankan

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

Masukkan alamat di docker-compose.yaml di sini:

    environment:
        XDEBUG_CONFIG: remote_host=172.19.0.1 

Basis data dan migrasi

Akses baris perintah

Jika Anda ingin terhubung ke server MySQL dari mesin host Anda, Anda dapat melakukannya menggunakan

 docker exec -it  mysql -u root -p

Server mysql di kontainer buruh pelabuhan Anda juga dapat dijangkau pada port 9906 dari localhost Anda

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

Kata sandi untuk pengguna root untuk db dropapp_dev adalah dropapp_root .

Akses meja kerja MySQL

Sebagian besar penggunaan menggunakan meja kerja untuk mengakses database MySQL. Untuk membuat koneksi, Anda perlu memasukkan alamat localhost Anda, misalnya 127.0.0.1 , untuk 'Nama Host' dan 9906 untuk 'Port'.

Migrasi Phinx

Kami menggunakan Phinx untuk menjalankan migrasi basis data.

Untuk bermigrasi ke versi database saat ini, jalankan

    vendor/bin/phinx migrate

Untuk membuat proses migrasi

    vendor/bin/phinx create 

Itu membuat file di db/migrations . Silakan gunakan file ini untuk menulis migrasi db Anda.

Cemara dan pengujian

Kami menggunakan Cypress untuk pengujian Browser. Silakan menjalankan tes Cypress di lingkungan lokal Anda

1. Instal Cypress melalui Unduh langsung
2. Setel variabel baseURL ke alamat lokal Anda, misalnya localhost:8100 di cypress.json.
3. Setel variabel env auth0Domain ke penyewa Auth0 pengembangan, misalnya boxtribute-dev.eu.auth0.com di cypress.json.
4. Buka Cypress dan repo ini di Cypress

Tes Cypress gagal karena pengguna tidak disinkronkan dengan Auth0

Jika pengujian 2.4 dan 2.9 gagal, periksa

• jika pengguna dengan [email protected] ada di Auth0 dan hapus dia
• jika [email protected] tidak memiliki awalan "m".
• jika [email protected] tidak memiliki peran yang ditetapkan
• jika testnewuser@ tidak ada.

Pedoman Cemara

Semua pengujian di cypress/integrations harus ditemukan dan dapat langsung dijalankan. Saat menulis tes, coba ikuti panduan berikut jika memungkinkan:

• Hindari duplikasi fungsi pembantu di beberapa file! Jika menguji halaman yang sama di beberapa rangkaian pengujian (file), ada kecenderungan untuk menyalin-menempelkan seluruh file dan kemudian menulis ulang pengujian. Hal ini menyebabkan duplikasi kode fungsi pembantu. Sebaliknya, fungsi pembantu yang diperlukan di beberapa lokasi harus ditentukan di salah satu file cypress/support - kemudian fungsi tersebut tersedia secara global. Temukan yang cocok berdasarkan nama atau buat yang baru. Dalam kasus terakhir, jangan lupa untuk mengimpornya dalam cypress/integrations/index.js . Hindari membuat nama file yang bermacam-macam karena cenderung menimbulkan kekacauan.
• Fungsi pembantu lokal yang ditentukan dalam file pengujian harus memiliki fungsi dan mudah dipahami, bukan nama teknis. Artinya, clickNewUserButton() lebih baik daripada clickElementByTypeAndTestId('button','new-user-button') .
• Pembantu penggunaan yang lebih umum seperti 'clickElementByTypeAndTestId' dapat digunakan dalam fungsi pembantu lokal jika diinginkan. Alasan preferensi penamaan fungsional terletak pada peningkatan keterbacaan tes.
• Basis kode saat ini tidak 100% mengikuti semua yang disebutkan di atas tetapi pasti akan membantu mengatur pembantu pengujian mulai sekarang.

Masalah Cypress yang Diketahui

Kami telah mengalami sebelumnya bahwa pengujian bisa gagal di CircleCI, tetapi tidak di lingkungan lokal. Alasan utamanya adalah Cypress biasanya menjalankan perintah lebih lambat di lingkungan pengembang lokal. Oleh karena itu, beberapa pedoman tambahan saat menulis tes:

• Bila ingin melakukan pengalihan, misal dengan mengklik tombol atau tab, silakan tambahkan pernyataan setelah klik, misal url cy.url().should('include', 'people_deactivated') . Karena pernyataan ini, cypress pasti akan menunggu hingga pengalihan dijalankan.
• Hanya jika Anda menggunakan cy.visit() Anda dapat yakin bahwa pengujian cypress menunggu hingga halaman dimuat sepenuhnya. Oleh karena itu, cobalah bernavigasi sebanyak mungkin dengan cy.visit() .

Catatan untuk menyiapkan penyewa Auth0

Jika Anda menyiapkan penyewa Auth0 baru, kami memerlukan akses ke API Manajemen Auth0. Untuk melakukan ini

• Di bawah 'API' pilih Auth0 Management API, buka 'Aplikasi Mesin ke Mesin' dan aktifkan akses
• Memberikan cakupan untuk membaca/memperbarui/menghapus/membuat pengguna dan user_app_metadata.

Pedoman kontribusi

Anda harus menjadi luar biasa dan baik hati. Untuk hal lainnya, silakan lihat pedoman kontribusi kami

Dengan siapa saya berbicara?

Kirimkan email kepada kami ke [email protected]!

Lisensi

Lihat file LISENSI untuk mengetahui hak dan batasan lisensi (Apache 2.0).