crossBILLy

crossBILLy - Michael Alekseew

@alekseew/ crossBILLy

Repositori ini berisi Aplikasi Web dan Lintas Platform (Web PWA, Windows, Mac OS X, iOS dan Android) untuk pembuatan tagihan yang mudah. Proyek ini akan membantu menjaga data pelanggan, melakukan pembuatan faktur/penagihan, ...

Kerangka kerja, platform, perpustakaan, plugin, konsep, arsitektur, teknik, ... yang digunakan atau dicoba adalah sebagai berikut:

• Model Percabangan Kontrol Sumber: GitFlow
• Platform/Kerangka Aplikasi Web Frontend: Angular
• Alat / Kerangka Pembuatan Lintas Platform: Kapasitor Ionik atau Cordova dan Elektron
• Bahasa Pengembangan: Naskah / ( JavaScript )
• Perpustakaan UI WebApp: Materi Sudut
• Perpustakaan "Perilaku" UI WebApp: CDK Sudut
• Pemformatan Kode: Lebih Cantik
• Pembuatan versi, Changelog otomatis (rilis): Versi Standar
• Alat Pesan Komit: Commitizen
• Alat Git-Hooks: Husky
• Animasi: Lottie & Lottie-Web
• Hosting dan banyak lagi... : FireBase
• Integrasi Berkelanjutan (CI) / Pengujian & Pembuatan: Travis
• Pemantauan Ketergantungan: Greenkeeper
• akan dilanjutkan...

Prasyarat

Proyek ini memerlukan dependensi berikut untuk diinstal terlebih dahulu:

• Node.js
• NPM

Ketergantungan

Untuk menginstal semua dependensi yang diperlukan, jalankan saja:

npm install

Ini juga menyiapkan templat pesan git commit (dan mengatur paket wip untuk menggunakan commitizen).

GitFlow

Silakan gunakan model percabangan GitFlow dan nama default untuk cabang SourceTree dalam proyek ini, informasi lebih lanjut dapat ditemukan di sini:

• GitFlow
• SourceTree + GitFlow

Konvensi penamaan nama cabang dan awalan (pengaturan default di SourceTree):

• Cabang produksi: master
• Cabang pengembangan: mengembangkan
• Awalan cabang fitur: feature/
• Awalan cabang rilis: rilis/
• Awalan cabang perbaikan terbaru: perbaikan terbaru/
• Tidak ada awalan tag Versi (nama Tag misalnya v0.1.0)

Changelog / Komit Konvensional

Dalam proyek ini (angular) komit konvensional Pedoman Pesan Komit Angular digunakan.

Mereka akan digunakan untuk membuat log perubahan secara otomatis dengan paket npm standard-version , untuk melakukan ini cukup jalankan npm run release . Ini akan melakukan tugas berikut:

• Perbarui versi proyek
• Hasilkan / perbarui CHANGELOG.md
• Komit perubahan ini (siap untuk push ke remote)
• Hasilkan tag git

Anda dapat menggunakan npm run commit untuk mendapatkan wizard yang membantu Anda menulis pesan commit yang benar (ini dilakukan dengan commitizen ).

Pesan komit juga akan diperiksa kebenarannya dengan commitlint (jika Anda benar-benar perlu melewatinya, Anda dapat melewati githooks, tetapi Anda tidak boleh melakukannya secara normal).

Anda dapat membuat templat pesan git commit dengan npm run prepare-git-commit-template , ini juga akan dilakukan selama instalasi npm.

Komit Format Pesan

Header (terdiri dari type , scope dan subject ) tidak boleh lebih dari 72 karakter.

 type(scope?): subject

body?

footer?

Jenis

Harus berupa salah satu dari berikut ini:

• prestasi : Sebuah fitur baru
• fix : Perbaikan bug
• docs : Hanya dokumentasi yang berubah
• style : Perubahan yang tidak mempengaruhi arti kode (spasi putih, format, titik koma hilang, dll)
• refactor : Perubahan kode yang tidak memperbaiki bug atau menambahkan fitur
• perf : Perubahan kode yang meningkatkan kinerja
• test : Menambahkan tes yang hilang atau memperbaiki tes yang ada
• build : Perubahan yang memengaruhi sistem build, konfigurasi CI, atau dependensi eksternal (contoh cakupan: gulp, brokoli, npm)
• ci : Perubahan pada file dan skrip konfigurasi CI kami (contoh cakupan: Travis, Circle, BrowserStack, SauceLabs)
• tugas : Perubahan lain yang tidak mengubah file src atau test
• revert : Mengembalikan komit sebelumnya

Cakupan

Cakupannya bisa berupa apa pun yang menentukan tempat perubahan penerapan. Saya menggunakan konvensi berikut (contoh):

• all : perubahan untuk keseluruhan proyek (rilis proyek umum, ...)
• root : perubahan pada root (folder) proyek
• be : perubahan pada bagian backend proyek
• fe : perubahan pada bagian frontend (webapp) proyek

Subjek

Subjek berisi deskripsi singkat tentang perubahan:

• gunakan bentuk imperatif, present tense: "ubah" bukan "berubah" atau "berubah"
• jangan menggunakan huruf kapital pada huruf pertama
• tidak ada titik (.) di akhir

Tubuh

Sama seperti pada subjek , gunakan bentuk imperatif, present tense: "perubahan" bukan "berubah" atau "perubahan". Tubuh harus memasukkan motivasi untuk perubahan dan membandingkannya dengan perilaku sebelumnya.

catatan kaki

Footer harus berisi informasi apa pun tentang Breaking Changes dan juga merupakan tempat untuk mereferensikan masalah JIRA yang dilakukan Closes ini.

Breaking Changes harus dimulai dengan kata BREAKING CHANGE: dengan satu atau dua baris baru. Pesan komit lainnya kemudian digunakan untuk ini.

Komit Kait

Dalam repo ini git hooks digunakan (diatur dengan husky ) untuk memeriksa kode sumber yang "bersih".

Pemeriksaan Format Lebih Cantik

Jika file TypeScript atau SCSS diubah dan didorong, hook komit dipicu dan file bertahap diformat dengan lebih cantik. Itu melakukan pemformatan/perubahan dan melakukan dan mendorong perubahan ini, dengan bantuan cukup cepat .

Komit Pesan Linting

Memeriksa apakah pesan git commit adalah pesan git commit konvensional, jika tidak maka akan membatalkan commit.

Versi & Rilis Proyek

Komit terakhir pada cabang rilis harus mengatur versi proyek dan menghasilkan Changelog, ini harus dilakukan dengan npm run release . Kumpulan ini adalah versi proyek , menghasilkan log perubahan dan melakukan perubahan ini . Informasi lebih lanjut dapat ditemukan di bab: Changelog Konvensional / Komit

Melanjutkan Integrasi & Penerapan

Pada proyek ini Travis CI diatur sebagai lint-, test-, e2e-tests- dan build-slave. Jika semuanya telah diuji dan berhasil dibangun, Travis CI akan menerapkan WebApp ke FireBase .