Welcome to zipcodejp 👋

A RESTful API for searching Japan Address by Zipcode (日本郵便番号検索 API)

👉 Playground

Data

Download from Japan Post

Prerequisites

• node 12.x

Install

yarn

Usage

yarn start

Your app should now be running on localhost:3000.

Deploying to Fly.io

https://fly.io/docs/languages-and-frameworks/node/

$ flyctl launch
$ flyctl deploy
$ flyctl status
$ flyctl open

Update Data

1. download latest data from Japan Post
2. run update-data script

$ cd data
$ node update-data.js

Author

👤 ThaddeusJiang

• Website: https://thaddeusjiang.com/
• Twitter: @ThaddeusJiang
• Github: @ThaddeusJiang

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2022 ThaddeusJiang.

This project is AGPL--3.0 licensed.

This README was generated with ❤️ by readme-md-generator