diff --git a/docs/README_id.md b/docs/README_id.md new file mode 100644 index 0000000..ea9ed19 --- /dev/null +++ b/docs/README_id.md @@ -0,0 +1,82 @@ +

API Wilayah Indonesia

+ +

+ NestJS + TypeScript + Prisma + MongoDB + PostgreSQL + MySQL +

+ +[English](../README.md) | [हिन्दी](README_hi.md) | [Tagalog](README_tl.md) | **Indonesia** + +API yang menyediakan informasi tentang **wilayah administratif Indonesia**, mulai dari tingkat provinsi, kabupaten, kecamatan, hingga tingkat desa. API ini juga menyediakan data pulau sejak [versi 1.1.0](https://github.com/fityannugroho/idn-area/releases/tag/v1.1.0). + +Dibuat dengan [NestJS framework](https://nestjs.com) dan ditulis dengan bahasa pemrograman TypeScript. [Prisma](https://www.prisma.io) digunakan sebagai ORM untuk berinteraksi dengan berbagai macam jenis database (MySQL, PostgreSQL, dan MongoDB). + +> **⚠️ Meningkatkan ke v3.0.0 ⚠️** +> +> Sejak [v3.0.0](https://github.com/fityannugroho/idn-area/releases/tag/v3.0.0), diperlukan **Node.js v18** atau versi yang lebih tinggi. + +

Daftar Isi

+ +- [Memulai](#memulai) +- [Data](#data) +- [Dokumentasi](#dokumentasi) +- [Demo](#demo) +- [Kontribusi](#kontribusi) +- [Melaporkan Masalah](#melaporkan-masalah) + - [Melaporkan Bug](#melaporkan-bug) + - [Meminta Fitur Baru](#meminta-fitur-baru) + - [Mengajukan Pertanyaan](#mengajukan-pertanyaan) +- [Dukung Proyek Ini](#dukung-proyek-ini) + +--- + +## Memulai + +Tolong baca [panduan instalasi](installation.md) untuk memasang dan menjalankan aplikasi ini. + +## Data +Data yang kami gunakan menggunakan sumber yang resmi, dikelola di repositori [**idn-area-data**](https://github.com/fityannugroho/idn-area-data) dan didistribusikan sebagai sebuah [npm package](https://www.npmjs.com/package/idn-area-data). + +> [data](https://github.com/fityannugroho/idn-area-data/tree/main/data) ini tersedia dibawah [Open Database License (ODbL)](https://github.com/fityannugroho/idn-area-data/blob/main/data/LICENSE.md). + +## Dokumentasi + +Baca versi terbaru dokumentasi API di [halaman dokumentasi](https://idn-area.cyclic.app/docs). Dokumentasi ini dibuat secara otomatis menggunakan [`@nestjs/swagger`](https://docs.nestjs.com/openapi/introduction). + +> Anda juga dapat mengakses dokumentasinya di perangkat lokal Anda dengan menjalankan aplikasi ini (lihat [Memulai](#memulai)) dan buka http://localhost:3000/docs di browser Anda. + +## Demo + +Anda dapat mencoba API ini dengan mengganti http://localhost:3000 dengan endpoint yang disediakan dalam deskripsi repositori ini. + +Berikut adalah beberapa proyek contoh yang menggunakan API ini: + +- [Simple area dropdown](https://github.com/fityannugroho/idn-area-example) +- [idn-area Map](https://github.com/fityannugroho/idn-area-map) + +## Kontribusi + +Jika Anda ingin berkontribusi pada proyek ini, harap baca file [CONTRIBUTING.md](../CONTRIBUTING.md) dan pastikan Anda mengikuti aturan yang ada di [Panduan Pull Request](../CONTRIBUTING.md#submitting-a-pull-request). + +## Melaporkan Masalah + +Kami memiliki berbagai kanal yang berbeda untuk setiap masalah, harap gunakan kanal dengan mengikuti syarat-syarat ini: + +### Melaporkan Bug +Untuk melaporkan bug, silahkan buka isu baru dengan mengikuti [panduan](../CONTRIBUTING.md#submitting-an-issue). + +### Meminta Fitur Baru +Jika Anda punya ide untuk fitur baru, silahkan buka isu baru dengan mengikuti [panduan](../CONTRIBUTING.md#submitting-an-issue). + +### Mengajukan Pertanyaan +Jika Anda punya pertanyaan, silahkan cari jawabanya di [Diskusi GitHub Kategori Tanya Jawab](https://github.com/fityannugroho/idn-area/discussions/categories/q-a). Jika Anda tidak menemukan diskusi yang relevan, Anda dapat membuka diskusi yang baru. + +## Dukung Proyek Ini + +Trakteer Saya + +Anda dapat mendukung proyek ini dengan berdonasi melalui [GitHub Sponsor](https://github.com/sponsors/fityannugroho), [Trakteer](https://trakteer.id/fityannugroho/tip), atau [Saweria](https://saweria.co/fityannugroho).