Light

fadlanzunima / kodepos Goto Github PK

View Code? Open in Web Editor NEW

This project forked from sooluh/kodepos

0.0 0.0 0.0 213 KB

:postbox: Indonesian postal code search API by place name, village or city.

Home Page: https://kodepos.vercel.app

License: Apache License 2.0

TypeScript 99.34% Procfile 0.66%

kodepos's Introduction

Getting Started

Clone this repository

git clone https://github.com/sooluh/kodepos.git

Change the current directory to this repository folder
```
cd kodepos
```
Install dependencies
```
yarn install
```
Run the app! (locally)
- Development mode
```
yarn dev
```
- Production mode
  1. Build first
```
yarn build
```
  2. Start the app
```
yarn start
```

One-click Deployment

The fastest way to use it privately on PaaS available

Basic Usage

Base URL : http://localhost:5000

Endpoint	Description	Parameter	Method
`/search`	To find postcode using keywords	`q`	`GET`

Example of Use

Request

curl -XGET 'http://localhost:5000/search/?q=danasari'

Response

{
  "success": true,
  "message": "Data search successfully parsed.",
  "data": [
    {
      "province": "Jawa Tengah",
      "city": "Purbalingga",
      "subdistrict": "Karangjambu",
      "urban": "Danasari",
      "postalcode": "53357"
    },
    {
      "province": "Jawa Tengah",
      "city": "Tegal",
      "subdistrict": "Bojong",
      "urban": "Danasari",
      "postalcode": "52465"
    },
    {
      "province": "Jawa Tengah",
      "city": "Pemalang",
      "subdistrict": "Pemalang",
      "urban": "Danasari",
      "postalcode": "52314"
    },
    {
      "province": "Jawa Barat",
      "city": "Ciamis",
      "subdistrict": "Cisaga",
      "urban": "Danasari",
      "postalcode": "46386"
    }
  ]
}

Showcase

List of awesome projects powered by this API

kodepos-web
Simple web-app for postcode search by dotslashf
Kode POS
Indonesia postal code search application (kotlin) by AzharRivaldi

Ready to use!

List of server APIs ready to use publicly

License

Code licensed under Apache 2.0 License.

kodepos's People

Contributors

Recommend Projects

React

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

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

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

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
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.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

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

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.