1
- ![ kodepos] ( https://socialify.git.ci/sooluh/kodepos/image?description=1&descriptionEditable=Indonesian%20postal%20code%20search%20API%20by%20place%20name%2C%20village%20or%20city.&font=Raleway&forks=1&issues=1&logo=https%3A%2F%2Fraw.githubusercontent.com%2Ftwitter%2Ftwemoji%2Fmaster%2Fassets%2Fsvg%2F1f4ee.svg&name=1&owner=1&pattern=Charlie%20Brown&pulls=1&stargazers=1&theme=Dark )
1
+ ![ @sooluh/kodepos ] ( https://socialify.git.ci/sooluh/kodepos/image?description=1&descriptionEditable=Indonesian%20postal%20code%20search%20API%20by%20place%20name%2C%20village%20or%20city.&font=Raleway&forks=1&issues=1&logo=https%3A%2F%2Fraw.githubusercontent.com%2Ftwitter%2Ftwemoji%2Fmaster%2Fassets%2Fsvg%2F1f4ee.svg&name=1&owner=1&pattern=Charlie%20Brown&pulls=1&stargazers=1&theme=Dark )
2
+
3
+ ## Requirements
4
+
5
+ - Node.js ` >= 16.20.1 `
6
+ - Yarn ` >= 1.22.0 `
2
7
3
8
## Getting Started
4
9
8
13
git clone https://github.com/sooluh/kodepos.git
9
14
```
10
15
11
- 2 . Change the current directory to this repository folder
16
+ 2 . Move to the repository directory
12
17
13
18
``` bash
14
19
cd kodepos
20
25
yarn install
21
26
```
22
27
23
- 4 . Run the app! ( locally)
28
+ 4 . Run locally
24
29
25
30
- Development mode
26
31
46
51
47
52
The fastest way to use it privately on PaaS available
48
53
49
- [! [Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone? repository-url=https%3A%2F%2Fgithub.com%2Fsooluh%2Fkodepos%2Ftree%2Fmain)
50
- [! [Deploy with Cyclic](https://ik.imagekit.io/sooluh/cyclic.svg)](https://app.cyclic.sh/# /join/sooluh)
54
+ < a href=" https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fsooluh%2Fkodepos%2Ftree%2Fmain" >
55
+ < img alt=" Deploy with Vercel" src=" https://vercel.com/button" height=" 32" />
56
+ < /a>
57
+ < a href=" https://app.koyeb.com/deploy?type=git&repository=github.com/sooluh/kodepos&branch=main&name=kodepos" >
58
+ < img alt=" Deploy with Koyeb" src=" https://www.koyeb.com/static/images/deploy/button.svg" height=" 32" />
59
+ < /a>
60
+ < a href=" https://render.com/deploy" >
61
+ < img alt=" Deploy with Render" src=" https://render.com/images/deploy-to-render-button.svg" height=" 32" />
62
+ < /a>
51
63
52
64
# # Basic Usage
53
65
54
- Base URL : [` http://localhost:5000 ` ](https://kodepos.vercel.app)
66
+ Base URL : [` http://localhost:3000 ` ](https://kodepos.vercel.app)
55
67
56
68
| Endpoint | Description | Parameter | Method |
57
69
| ---------------------------------------------- | ------------------------------- | --------- | ------ |
@@ -62,43 +74,43 @@ Base URL : [`http://localhost:5000`](https://kodepos.vercel.app)
62
74
# ### Request
63
75
64
76
< pre>
65
- curl -XGET ' <a href="https://kodepos.vercel.app/search/ ?q=danasari">http://localhost:5000 /search/?q=danasari</a>'
77
+ curl -XGET ' <a href="https://kodepos.vercel.app/?q=danasari">http://localhost:3000 /search/?q=danasari</a>'
66
78
< /pre>
67
79
68
80
# ### Response
69
81
70
82
` ` ` json
71
83
{
72
- " success " : true ,
73
- " message " : " Data search successfully parsed. " ,
84
+ " statusCode " : 200 ,
85
+ " code " : " OK " ,
74
86
" data" : [
75
87
{
76
88
" province" : " Jawa Tengah" ,
77
- " city " : " Purbalingga" ,
78
- " subdistrict " : " Karangjambu" ,
79
- " urban " : " Danasari" ,
80
- " postalcode " : " 53357"
89
+ " regency " : " Purbalingga" ,
90
+ " district " : " Karangjambu" ,
91
+ " village " : " Danasari" ,
92
+ " code " : " 53357"
81
93
},
82
94
{
83
95
" province" : " Jawa Tengah" ,
84
- " city " : " Tegal" ,
85
- " subdistrict " : " Bojong" ,
86
- " urban " : " Danasari" ,
87
- " postalcode " : " 52465"
96
+ " regency " : " Tegal" ,
97
+ " district " : " Bojong" ,
98
+ " village " : " Danasari" ,
99
+ " code " : " 52465"
88
100
},
89
101
{
90
102
" province" : " Jawa Tengah" ,
91
- " city " : " Pemalang" ,
92
- " subdistrict " : " Pemalang" ,
93
- " urban " : " Danasari" ,
94
- " postalcode " : " 52314"
103
+ " regency " : " Pemalang" ,
104
+ " district " : " Pemalang" ,
105
+ " village " : " Danasari" ,
106
+ " code " : " 52314"
95
107
},
96
108
{
97
109
" province" : " Jawa Barat" ,
98
- " city " : " Ciamis" ,
99
- " subdistrict " : " Cisaga" ,
100
- " urban " : " Danasari" ,
101
- " postalcode " : " 46386"
110
+ " regency " : " Ciamis" ,
111
+ " district " : " Cisaga" ,
112
+ " village " : " Danasari" ,
113
+ " code " : " 46386"
102
114
}
103
115
]
104
116
}
@@ -110,16 +122,19 @@ List of awesome projects powered by this API
110
122
111
123
- [** kodepos-web** ](https://github.com/dotslashf/kodepos-web)< br>
112
124
Simple web-app for postcode search by [dotslashf](https://github.com/dotslashf)
125
+
113
126
- [** Kode POS** ](https://github.com/AzharRivaldi/Kode-POS-Indonesia)< br>
114
127
Indonesia postal code search application (kotlin) by [AzharRivaldi](https://github.com/AzharRivaldi)
115
128
116
129
# ## Ready to use!
117
130
118
131
List of server APIs ready to use publicly
119
132
120
- - [https://kodepos.vercel.app](https://kodepos.vercel.app/? json=true)
121
- - [https://kodepos.cyclic.app](https://kodepos.cyclic.app/? json=true)
133
+ - [https://kodepos.vercel.app](https://kodepos.vercel.app/? q=danasari) < sup><sub> ` latest` < /sub></sup>
134
+ - [https://kodepos.cyclic.app](https://kodepos.cyclic.app/? q=danasari) < sup><sub> ` latest` < /sub></sup>
135
+ - [https://kodepos.onrender.com](https://kodepos.onrender.com/? q=danasari) < sup><sub> ` latest` < /sub></sup>
136
+ - [https://kodepos-82o09pkha-sooluh.vercel.app](https://kodepos-82o09pkha-sooluh.vercel.app/? q=danasari) < sup><sub> ` v2.2.0` < /sub></sup>
122
137
123
138
# ## License
124
139
125
- Code licensed under [Apache 2.0 License](https://github.com/sooluh/kodepos/blob/main/LICENSE).
140
+ This project is licensed under [Apache 2.0 License](https://github.com/sooluh/kodepos/blob/main/LICENSE).
0 commit comments