Welcome to zipcodejp 👋

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

Playground

👉 https://zipcodejp.zeabur.app/

Data

Download from Japan Post

Prerequisites

Install

bun install

Usage

bun start

Your app should now be running on localhost:3000.

Deploying

docker run -p 3000:3000 thaddeusjiang/zipcodejp

Your app should now be running on localhost:3000.

Update Data

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

$ bun run update-data

Author

👤 ThaddeusJiang

• Website: https://thaddeusjiang.com/
• X: @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