Merupakan full stack framework untuk membuat aplikasi. Ini bisa digunakan sebagai library atau juga digunakan sebagai base project template. APF telah dipersiapkan dengan komponen-komponen penting dalam membangun aplikasi full stack dari A-Z.
Framework ini didesain dengan memperhatikan beberapa aspek seperti: kemudahan, fleksibelitas, performa, produktivitas, dan psikologi programmer :D.
Daftar komponen & fitur yang ditawarkan:
- Backend, ditulis menggunakan Rust dengan database bawaan PostgreSQL.
- Frontend, tersedia beberapa framework untuk: web React dan Vue, mobile: React Native dan Flutter.
- Dokumentasi, tersedia lib-docs untuk membuat dokumentasi library inti dan api-docs untuk membangun dokumentasi API dengan menggunakan standar Blueprint API.
- Test, tersedia testkit library yang didesain untuk mempermudah membuat unittest dan integration test.
- Deployment, tersedia dukungan Docker untuk mempermudah deployment dan development local.
- Migration, untuk mempermudah mengelola skema database, APF menggunakan diesel CLI yang bisa digunakan sebagai database control management.
- Messaging, untuk kebutuhan distributed computing maka telah disediakan Protocol buffer untuk komunikasi antar node.
Daftar kebutuhan berikut dibutuhkan apabila kita ingin melakukan build di mesin environment lokal, kamu bisa juga melakukan build menggunakan Docker sehingga tidak perlu menginstall satu-per-satu kebutuhan ini. Untuk build menggunakan Docker lihat bagian Build menngunakan Docker. Berikut kebutuhan pokok untuk bisa melakukan build di mesin lokal:
- Rust
- PostgreSQL >= 9.x
- diesel
- Aglio (optional, untuk dokumentasi)
- Rustfmt
- Cargo clippy
- Cargo audit
- Protocol Buffer
Sebelum melakukan build pastikan dulu Libpq (Library-nya PostgreSQL) telah tersedia, di Ubuntu bisa menggunakan perintah apt install libpq-dev atau di Debian apt install libpq-devel, di OSX bisa menggunakan perintah: brew install libpq.
Setelah semua dependensi tersedia, ketikkan:
$ cargo build
Cara paling mudah untuk melakukan build adalah menggunakan Docker:
$ docker run -it --rm -v $(pwd):/workdir \
-v /tmp:/root/.cargo/git \
-v /tmp:/root/.cargo/registry \
anvie/rust-musl-build:latest \
cargo build --release --target=x86_64-unknown-linux-musl
Docker image anvie/rust-musl-build adalah container berbasis Linux dan sudah berisi semua kebutuhan development untuk build project ini, setelah build selesai
output bisa didapatkan di target/x86_64-unknown-linux-musl.
Kamu bisa juga menjalankan perintah tersebut menggunakan make:
$ make release-linux
Testing kebanyakan ditulis terintegrasi (integration testing), untuk itu perlu menjalankan database dan mempersiapkan environment-nya, ini hanya perlu dijalankan sekali, ketikkan:
$ make test-env
CATATAN: Perintah test-env akan membuat database baru dengan nama apf_test dimana database ini akan digunakan
sebagai storage ketika proses testing terjadi.
Perintah make test-env ini juga perlu dijalankan ulang apabila ada perubahan schema untuk memastikan schema
dalam database selalu up-to-date.
Untuk melakukan test ketikkan:
$ make test
Untuk menjalankan service apf perlu dipastikan service PostgreSQL sudah jalan terlebih dahulu, dan telah disetup database-nya,, untuk men-setup database bisa menggunakan perintah:
$ make reset-db
Selanjutkan jalankan APF servernya:
$ cargo run --bin apf_server
Stack frontend kita bisa menggunakan React atau Vue.js, base ada di direktori /frontends.
Apabila ingin mencoba menjalankannya bisa check frontend untuk admin-react:
$ cd frontends/admin-react
$ npm install
$ npm start
Untuk Vue.js ada di /frontends/admin-vue:
$ cd frontends/admin-vue
$ yarn install
$ yarn serve
CATATAN: Kamu bisa menggunakan npm maupun yarn, tapi direkomendasikan menggunakan yarn.
Dokumentasi dibagikan menjadi beberapa bagian:
- Dokumentasi pustaka (library).
- Dokumentasi Rest API.
Untuk menggenerasikan dokumentasi pustaka cukup ketikkan:
$ make lib-docs
Untuk menggenerasikan dokumentasi rest API:
$ make api-docs
CATATAN: Penggenerasian dokumentasi untuk rest API membutuhkan tool Aglio.
Setiap perubahan pada project ini harus mengikuti konvensi ini.
Sebelum melakukan commit harus:
- Memastikan kodenya telah diformat menggunakan perintah:
make fmt. - Memastikan kodenya telah layak sesuai standar dengan cara menjalankan perintah:
make lint. - Memastikan kodenya telah lolos unittest dengan cara menjalankan perintah:
make test. - Memastikan kodenya telah aman dari dependensi yang bermasalah dengan menjalankan perintah:
make audit. - Menggunakan tata bahasa yang mudah dipahami dan menjelaskan perubahan mendasar pada commit message-nya.
Case
$ docker-compose up
ERROR: Version in "./docker-compose.yml" is unsupported.
Itu artinya versi docker-compose yang ada di sistem mu tidak support, maka perlu dilakukan install manual:
Fix (ubuntu 16.04)
$ sudo curl -L sudo curl -L "https://github.com/docker/compose/releases/download/1.22.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
$ sudo chmod +x /usr/local/bin/docker-compose
Case
Ketika install diesel muncul error seperti berikut:
$ cargo install diesel_cli --no-default-features --features postgres
Error : cannot find lpg
Itu artinya library postgres-devel belum diinstall, maka perlu intsall dulu libpq:
Fix (ubuntu 16.04) sudo apt install libpq-dev
Case
Ketika sedang compile/test gagal dengan error kurang lebih seperti ini:
ERROR apf::api::error] error: "relation \"transactions\" does not exist"
Itu artinya table schema mu yang digunakan untuk test belum up-to-date dengan schema terbaru, maka perlu dilakukan migration untuk apply patch-nya:
$ diesel migration run --database-url postgresql://localhost/apf_test?sslmode=disable
Atau reset database untuk test-nya agar di-rebuild schema-nya dari pertama:
$ make test-env
Apabila ada yang perlu ditanyakan contact: r@ansvia.com