CONTRIBUTING.md

Setup Proyek

Proyek ini adalah monorepo Nx. Lihat dokumentasi Nx untuk informasi lebih lanjut tentang struktur proyek dan perintahnya atau untuk memanfaatkan kekuatan penuh Nx.

Prasyarat Umum

• Node.js >= 21.1.0
• pnpm >= 8.10.0
• Docker >= 24.0.7 (opsional)
• PostgreSQL >= 13.4 (opsional jika Docker digunakan)

Prasyarat Pengembangan Aplikasi Android

• Java >= 17.0.9
• Android Studio >= 2020.3.1
• Android SDK >= 31.0.0

Pengaturan Awal

Ini adalah langkah demi langkah bagaimana membangun dan menjalankan lingkungan pengembangan lokal. Cukup R.T.F.M. jika Anda tahu apa yang Anda lakukan.

• Pastikan Anda telah menginstal semua prasyarat.
• Kloning repositori menggunakan Git.

git clone https://github.com/trashtrack-team/trashtrack

• Instal dependensi menggunakan pnpm install.
• Salin .env.example ke .env atau .env.local dan isi nilainya di dalam apps/api.

Menjalankan Proyek

Melakukan bootstrap pada database

• Mulai database menggunakan pnpm nx run api:docker-compose-up atau server PostgreSQL lokal.
• Deploy migrasi prisma ke database menggunakan pnpm nx run api:prisma-deploy.
• Akses database menggunakan pnpm nx run api:prisma-studio atau menggunakan aplikasi manajemen database seperti PGAdmin.

Melakukan build dan menjalankan aplikasi Android

• Build frontend aplikasi menggunakan pnpm nx run app:build.
• Sinkronkan frontend aplikasi ke perangkat Android lewat Capactior menggunakan pnpm nx run app:sync:android.
• Jalankan aplikasi lewat Android Virtual Device atau perangkat fisik menggunakan pnpm nx run app:run:android.
  • Atau menggunakan perintah pnpm nx run app:open:android untuk membuka aplikasi di Android Studio.

Melakukan build dan menjalankan API

• Build server API menggunakan pnpm nx run api:build.
• Jalankan server API menggunakan pnpm nx run api:serve.