digital form builder

Pembuat Formulir Digital XGov

kontribusi

Masalah dan permintaan penarikan dipersilakan. Silakan periksa CONTRIBUTING.md terlebih dahulu!

Repositori ini adalah repo mono

• @xgovformbuilder/runner - Server Hapi yang dapat 'menjalankan' formulir dari file JSON
• @xgovformbuilder/designer - Aplikasi React untuk membantu pembuatan formulir
• @xgovformbuilder/model - Melayani model data dan pembantu lainnya
• @xgovformbuilder/e2e - tes ujung ke ujung

Repo tersebut merupakan cabang dari pembuat formulir digital DEFRA.

Ini adalah (mendekati) repositori ruang kerja benang 2 tanpa instalasi. .yarnrc.yml memungkinkan kita menyelaraskan lingkungan benang kita. Harap komit plugin apa pun di .yarn, tetapi jangan komit .yarn/cache Anda. CI akan menyimpan dan memulihkan cache.

Ruang kerja akan menangani sym-linking paket, jadi kita tidak perlu menjalankan yarn link secara manual. Ini juga akan menangani pengangkatan node_modules untuk paket apa pun yang dibagikan antar repo, sehingga mengurangi waktu instalasi. Semoga semuanya berhasil™️.

Lihat juga file README repo individual untuk info tambahan:

• pelari README
• desainer README
• model README
• e2e (tes asap) README

Pengaturan

Selalu jalankan skrip dari direktori root.

1. Pastikan Anda menggunakan node 20 node --version .
2. Pastikan Anda telah menginstal benang 1.22+. Anda tidak perlu menginstal benang 2.4+, benang akan mendeteksi biner benang 2 dalam .yarn dan itu akan digunakan.
3. Jika menggunakan desainer:
   • Perhatikan bahwa perancang mengharuskan pelari untuk berjalan dengan pengaturan NODE_ENV=development default (lihat runner/config/development.json) untuk mengaktifkan pengeposan dan pratinjau formulir selama desain.
4. Jalankan perintah $ yarn untuk menginstal semua dependensi di semua ruang kerja.
5. Jalankan $ yarn build untuk membangun semua ruang kerja (ini diperlukan karena dependensi dapat bergantung satu sama lain).

Seperti telah disebutkan, selalu jalankan skrip dari direktori root. karena ruang kerja tidak memiliki skrip atau paket, Anda perlu menjalankannya dari dalam foldernya dan dengan menjalankan di direktori root benang 2 dapat menyelesaikan skrip/paket dengan benar.

Untuk mempelajari lebih lanjut tentang ruang kerja, periksa tautan berikut:

• Ruang kerja di Benang
• Ruang kerja

saya ingin...

menjalankan skrip ruang kerja tertentu

$ yarn [runner|designer|model] name-of-script

misal: yarn designer start atau yarn runner add babel-core --dev

jalankan skrip untuk setiap ruang kerja

$ yarn workspaces foreach run name-of-script

perhatikan dan buat perubahan di semua repo

Saya tidak akan merekomendasikannya kecuali Anda memiliki prosesor yang kuat.

$ yarn watch

tambahkan ketergantungan ke semua ruang kerja

$ yarn add packagename

membuat ruang kerja baru

1. buat direktori baru untuk ruang kerja dan benang di dalamnya
   1. $ mkdir myNewLib
   2. $ cd myNewlib
   3. $ yarn init
2. di package.json root.json
   1. tambahkan myNewLib ke objek workspaces .

Pemecahan masalah

Jika Anda mengalami masalah, kirimkan masalah atau kirim pesan melalui gitter.

Kesalahan: ENOENT: tidak ada file atau direktori seperti itu, scandir 'xxx/node_modules/node-sass/vendor'

/vendor tidak ada karena belum dibangun atau dibangun kembali. Anda mungkin juga mendapatkan masalah ini dengan core-js , fsevents , nodemailer , dll. $ yarn rebuild untuk membangun kembali semua paket $ yarn rebuild only node-sass untuk membangun kembali hanya node-sass

CI

Kami menggunakan tindakan GitHub untuk menjalankan proses CI kami. Lihat visualisasi alur kerja di sini.

Pembuatan versi

Nomor versi akan bertambah secara otomatis berdasarkan pesan komit dan SemVer (Major.Minor.Patch). Saat menggabungkan, tambahkan komit penggabungan Anda dengan yang berikut ini:

• major: atau breaking: - misalnya, breaking: removing feature X . Ini akan menambah versi UTAMA - misalnya: 1.1.0 menjadi 2.0.0
• minor: atau feature: - misalnya, feature: new component . Ini akan menambah versi MINOR - misalnya: 1.1.0 menjadi 1.2.0
• patch: atau fix: - misalnya, fix: url bug - ini akan menambah versi PATCH - misalnya: 1.0.0 ke 1.0.1 (ini juga akan terjadi secara default)

Lingkungan pengembangan

Alur kerja pengembangan dipicu setiap kali PR digabungkan ke main, dan Anda dapat memantaunya di tab tindakan repositori.

Alur kerja berisi dua pekerjaan terpisah yang berjalan secara paralel, satu untuk Runner dan satu lagi untuk aplikasi Designer.

Kedua pekerjaan tersebut bekerja sebagai berikut:

1. Bangun image buruh pelabuhan dengan semua dependensi.
2. Dorong gambar ke Heroku Container Registry.
3. Rilis gambar terbaru.

Rilisan terbaru akan dijalankan di sini: Runner / Designer.

Tes asap

Serangkaian tes asap dijalankan terhadap semua PR. Ada Pekerjaan Cron yang menjalankan tes asap terhadap penerapan Heroku dan dijadwalkan untuk dijalankan pada tengah malam setiap hari.

Rangkaian tes asap lama dapat ditemukan di repositori ini. Mereka telah dihapus sehingga proyek dapat berjalan di node 18.

Tes asap akan dimigrasikan untuk menggunakan cypress.io dalam beberapa bulan mendatang.