Giter VIP home page Giter VIP logo

api-nusantara-kita's Introduction

API NUSANTARA-KITA

API ini menyediakan data lengkap mengenai wilayah-wilayah di Indonesia yang telah dideploy menggunakan VERCEL, semoga API ini bisa bermanfaat untuk kalian, dan selamat mencoba.

Demo: https://nusantara-kita.yuefii.my.id

  • /api/nusantara/provinces
  • /api/nusantara/{provinces_code}/regencies
  • /api/nusantara/{regency_code}/districts
  • /api/nusantara/{district_code}/villages

noted Karna Api ini dihosting menggunakan hosting yang free jadi akan terbatas untuk consume api nya jadi lebih baik kalian hosting sendiri project ini.

Fork project ini ke repostory kalian lalu kemudian deploy API nya.

Fitur

API ini berisi seluruh data wilayah indonesia mulai dari:

  • Provinsi
  • Kabupaten/Kota
  • Kecamatan
  • Desa

Dokumentasi Project

Untuk dokumentasi lengkap dan ingin mencoba apinya kalian bisa cek yuefii.my.id/nusantara-kita

Database API

Data yang kami gunakan didasarkan pada data resmi dari pemerintah dan disimpan dalam file CSV yang dipisahkan berdasarkan tingkatan dalam direktori data.

Instalasi

Langkah-langkah cara install project ini dilokal :

Git clone

git clone https://github.com/Yuefii/api-nusantara-kita.git

Masuk ke directori project

cd api-nusantara-kita

Menjalankan Projectnya menggunakan YARN

  • install dependencies
    yarn install
    
  • jalankan projectnya
    yarn dev
    

Jika kalian ingin menggunakan Docker

Untuk Menjalankannya di Development

docker-compose -f docker-compose.yaml up --build

noted Untuk menggunakan Docker pada development kalian harus yarn install atau npm install terlebih dahulu, untuk menginstall node_modules tidak seperti Production yang bisa langsung berjalan.

Untuk Menjalankannya di Production

docker-compose -f docker-compose.prod.yaml up --build -d

Jika kalian ingin lebih mudah lagi bisa menggunakan Make

Caranya kalian ketika gunakan command ini :

  • make dev
  • make dev-down
  • make prod
  • make prod-down

Untuk selengkapnya kalian bisa cek di pada Makefile disana akan ada komentar yang menjelaskan kegunaannya.

noted Untuk menggunakan Make kalian harus menginstall nya terlebih dahulu.

Endpoint

1. Mengambil Data Provinsi

GET http://localhost:8080/api/nusantara/provinces

2. Mengambil Data Kabupaten/Kota berdasarkan kode Provinsi

GET http://localhost:8080/api/nusantara/{provinces_code}/regencies

3. Mengambil Data Kecamatan berdasarkan kode Kabupaten/kota

GET http://localhost:8080/api/nusantara/{regency_code}/districts

4. Mengambil Data Desa berdasarkan kode Kecamatan

GET http://localhost:8080/api/nusantara/{district_code}/villages

api-nusantara-kita's People

Contributors

yuefii avatar

Stargazers

Abdillah Juniansyah avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.