Skip to content

Commit

Permalink
Merge pull request #35 from Cocon/release/v2.0.1
Browse files Browse the repository at this point in the history
release/v2.0.1をmainブランチにマージ
  • Loading branch information
YuukiToriyama authored Apr 18, 2024
2 parents d5483fd + 3de2ebf commit 02cbe9c
Show file tree
Hide file tree
Showing 6 changed files with 712 additions and 5,760 deletions.
32 changes: 32 additions & 0 deletions .github/workflows/ghpages.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Deploy demo page to GitHub Pages

on:
push:
branches: [ 'main' ]

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20.x'

- name: Install dependencies
run: npm install

- name: Build package
run: npm run build:web

- name: Move files
run: |
mv ./dist ./demo
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./demo
28 changes: 28 additions & 0 deletions .github/workflows/upload-npmjs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Upload package to npmjs.com

on:
push:
tags:
- 'v*'

jobs:
publish:
runs-on: ubuntu-latest
environment: npmjs
steps:
- uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20.x'
registry-url: 'https://registry.npmjs.org'
scope: '@coconmap'

- name: Install dependencies
run: npm install

- name: Publish package
run: npm publish --access public
env:
NODE_AUTH_TOKEN: ${{ secrets.NPMJS_REGISTRY_TOKEN }}
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,25 @@
# Leaflet.CommunityGeoCoder

Leaflet.js 地図に住所検索機能を追加するプラグインです。
検索窓に日本国内の住所を入力するとその場所に地図が遷移します
検索窓に日本国内の住所を入力すると、その場所にピンを立て、その場所まで遷移します

## Demo

[こちら](https://cocon.github.io/Leaflet.CommunityGeoCoder/demo/)に簡単なデモとサンプルコードをご用意しています
[こちら](https://cocon.github.io/Leaflet.CommunityGeoCoder/demo/)にデモとサンプルコードを用意しています

![demo page](https://i.imgur.com/7oXSJMr.png)
![画面イメージ](https://i.imgur.com/7oXSJMr.png)

住所を入力してボタンを押すと、地図がその場所まで遷移します。
町名まで入れていただくと、かなりピンポイントな地点まで移動します。
住所を入力して検索ボタンを押すと、地図がその場所まで遷移します。
詳しい住所を入力すれば、かなりピンポイントな地点まで移動します。

なおこちらのサンプルでは、株式会社 Geolonia さんの[オープンソース住所正規化ライブラリ](https://github.com/geolonia/normalize-japanese-addresses)を使用しています。サンプルを触っていただき気に入っていただけましたら、Geoloniaさんの製品もぜひチェックしていただければと思います。
なおこちらのサンプルでは、株式会社 Geolonia さんの[オープンソース住所正規化ライブラリ](https://github.com/geolonia/normalize-japanese-addresses)を使用しています。
サンプルを触っていただき気に入っていただけましたら、Geoloniaさんの製品もぜひチェックしていただきたいです!

## Usage

Leaflet.CommunityGeocoder単体では住所の検索はできません。
別途、住所正規化のライブラリをインストールしていただく必要があります。
ここでは株式会社 Geolonia さんの`@geolonia/normalize-japanese-addresses`を用いたコードサンプルをご紹介します
ここでは株式会社 Geolonia さんの`@geolonia/normalize-japanese-addresses`を用いた例をご紹介します

```bash
npm install @coconmap/leaflet.communitygeocoder
Expand Down Expand Up @@ -51,7 +52,7 @@ geoCoder.on(map);
geoCoder.search("東京都千代田区霞が関1-3-1");
```

また、バンドラーを使わない場合はJsDelivrなどのCDNをご利用いただけます。
バンドラーを使わない場合はJsDelivrなどのCDNをご利用いただけます。

```text
https://cdn.jsdelivr.net/npm/@coconmap/leaflet.communitygeocoder/dist/bundle.js
Expand All @@ -74,12 +75,12 @@ interface NormalizeResult {
}
```

この定義に準拠していさえすればどのようなライブラリでもお使いいただくことができます
もしこのような正規化ライブラリを開発中の方がおられましたら、Issue等で連絡いただけますと光栄です
この定義に準拠していさえすればどのようなライブラリでもお使いいただけます
もしこのような正規化ライブラリを開発中の方がおられましたら、Issue等で連絡いただけますと嬉しいです

## Author

YUUKIToriyama([@CoconMap](https://mobile.twitter.com/CoconMap/))
Torichan([@CoconMap](https://mobile.twitter.com/CoconMap/))

## Thanks to

Expand Down
2 changes: 1 addition & 1 deletion demo/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<link rel="help" href="https://github.com/Cocon/Leaflet.CommunityGeoCoder">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/leaflet@1.8.0/dist/leaflet.css">
<script src="https://cdn.jsdelivr.net/npm/leaflet@1.8.0/dist/leaflet.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@coconmap/leaflet.communitygeocoder/dist/bundle.js"></script>
<script src="./dist/bundle.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@geolonia/normalize-japanese-addresses@2.7.2/dist/main-browser.min.js"></script>
<script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
<style>
Expand Down
Loading

0 comments on commit 02cbe9c

Please sign in to comment.