Awesome
<a href="https://s.id/standwithpalestine"><img alt="I stand with Palestine" src="https://cdn.jsdelivr.net/gh/Safouene1/support-palestine-banner@master/banner-project.svg" width="100%" /></a>
Requirements
- Node.js
>= 20.x - npm
Getting Started
-
Clone this repository
git clone https://github.com/sooluh/kodepos.git -
Move to the repository directory
cd kodepos -
Install dependencies
npm ci -
Run locally
-
Development mode
npm run dev -
Production mode
-
Build first
npm run build -
Start the app
npm run start
-
-
One-click Deployment
The fastest way to use it privately on PaaS available
<a href="https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fsooluh%2Fkodepos%2Ftree%2Fmain"> <img alt="Deploy with Vercel" src="https://vercel.com/button" height="32" /> </a> <a href="https://app.koyeb.com/deploy?type=git&repository=github.com/sooluh/kodepos&branch=main&name=kodepos"> <img alt="Deploy with Koyeb" src="https://www.koyeb.com/static/images/deploy/button.svg" height="32" /> </a> <a href="https://render.com/deploy"> <img alt="Deploy with Render" src="https://render.com/images/deploy-to-render-button.svg" height="32" /> </a>Open in
<a href="https://idx.google.com/import?url=https%3A%2F%2Fgithub.com%2Fsooluh%2Fkodepos"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://cdn.idx.dev/btn/open_light_32.svg"> <source media="(prefers-color-scheme: light)" srcset="https://cdn.idx.dev/btn/open_dark_32.svg"> <img height="32" alt="Open in IDX" src="https://cdn.idx.dev/btn/open_purple_32.svg"> </picture> </a> <a href="https://gitpod.io/#https://github.com/sooluh/kodepos"> <img alt="Open in Gitpod" src="https://gitpod.io/button/open-in-gitpod.svg" height="32" /> </a> <a href="https://codespaces.new/sooluh/kodepos"> <img alt="Open in GitHub Codespaces" src="https://github.com/codespaces/badge.svg" height="32" /> </a>Endpoints
Search by Place Name
[ENDPOINT] /search
Query strings
| Params | Description | Required |
|---|---|---|
| q | Search keywords | ✅ |
Response
{
"statusCode": 200,
"code": "OK",
"data": [
{
"code": 46386,
"village": "Danasari",
"district": "Cisaga",
"regency": "Ciamis",
"province": "Jawa Barat",
"latitude": -7.3271342,
"longitude": 108.4577572,
"elevation": 110,
"timezone": "WIB"
},
{
"code": 53357,
"village": "Danasari",
"district": "Karangjambu",
"regency": "Purbalingga",
"province": "Jawa Tengah",
"latitude": -7.1857161,
"longitude": 109.4368274,
"elevation": 705,
"timezone": "WIB"
},
{
"code": 52314,
"village": "Danasari",
"district": "Pemalang",
"regency": "Pemalang",
"province": "Jawa Tengah",
"latitude": -6.8649882,
"longitude": 109.3956117,
"elevation": 6,
"timezone": "WIB"
},
{
"code": 52465,
"village": "Danasari",
"district": "Bojong",
"regency": "Tegal",
"province": "Jawa Tengah",
"latitude": -7.1153626,
"longitude": 109.1850778,
"elevation": 737,
"timezone": "WIB"
}
]
}
Search by Coordinates
[ENDPOINT] /detect
Query strings
| Params | Description | Required |
|---|---|---|
| latitude | Location latitude | ✅ |
| longitude | Location longitude | ✅ |
Response
{
"statusCode": 200,
"code": "OK",
"data": {
"code": 41152,
"village": "Kembangkuning",
"district": "Jatiluhur",
"regency": "Purwakarta",
"province": "Jawa Barat",
"latitude": -6.5495591,
"longitude": 107.4121855,
"elevation": 112,
"timezone": "WIB",
"distance": 1.5894826841413479
}
}
Showcase
List of awesome projects powered by this API
-
kodepos-web<br> Simple web-app for postcode search by dotslashf
-
Kode POS<br> Indonesia postal code search application (kotlin) by AzharRivaldi
Ready to use!
List of server APIs ready to use publicly
[!IMPORTANT] For production usage, we recommend deploying it on your own and not using the list below. The list below can be used for development or learning purposes only!
- https://kodepos.vercel.app
latest - https://kodepos.onrender.com
latest
License
This project is licensed under Apache 2.0 License.