Nusantara Kita

Nusantara Kita adalah sebuah API yang menyediakan data wilayah Indonesia. Project ini dirancang untuk memudahkan akses dan penggunaan data geospasial terkait wilayah-wilayah di Indonesia. API ini dapat digunakan untuk berbagai aplikasi yang memerlukan informasi seperti batas wilayah, data administratif, dan lain-lain. Semoga API ini bisa bermanfaat untuk kalian, dan selamat mencoba.

URL:

• API = https://api-nusakita.vercel.app
• DOKUMENTASI = https://nusakita.vercel.app

ENDPOINT:

• /v2/provinsi
• /v2/kab-kota
• /v2/kecamatan
• /v2/desa-kel
• /v2/{kodeProvinsi}/kab-kota
• /v2/{kodeKabKota}/kecamatan
• /v2/{kodeKecamatan}/desa-kel

API ini dihosting menggunakan VERCEL jadi akan terbatas untuk consume api nya jadi lebih baik kalian hosting sendiri project ini diserver kalian.

Fitur

API ini berisi seluruh data wilayah indonesia beserta lokasinya mulai dari:

• Provinsi
• Kabupaten/Kota
• Kecamatan
• Desa/Kelurahan

Instalasi

Langkah-langkah cara install project ini dilokal :

Git clone API nya:

git clone --filter=blob:none --no-checkout https://github.com/Yuefii/NusantaraKita.git
cd NusantaraKita
git sparse-checkout set api
git checkout

Masuk ke directori API:

cd api

Setup Environmentnya:

cp .env.example .env

Menjalankan Projectnya menggunakan pip

• create virtual environment:

  python -m venv venv

• activate virtual environment:

  source venv/bin/activate

• install dependencies:

  pip install -r requirements.txt

• Running project:

  uvicorn generate:app --reload

• Testing project:

  pytest tests/

References

Dataset yang digunakan dalam project ini berasal dari:

• https://github.com/cahyadsn/wilayah_boundaries

Kami sangat menghargai pembuat dataset ini. Tanpa adanya data tersebut, project ini tidak akan bisa dikembangkan.

Berkontribusi & Kode Etik

Baca panduan kontribusi kami untuk mempelajari cara berkontribusi pada proyek kami.

Pastikan untuk mematuhi kode etik kami.

License

Project ini dilisensikan di bawah Lisensi MIT - lihat LICENSE untuk detailnya.