Skip to content

I-H-dot/ShindaiMap

Repository files navigation

神大Map

CI License: MIT

神大Mapを開く

神戸大学の公式地図番号、教室、図書館、トイレ、休憩場所、ラーニングコモンズ、ATM、ポスト、バス停などを1画面で探すためのWebマップです。

Important

神大Mapは有志による非公式プロジェクトです。神戸大学が運営・保証するサービスではありません。重要な移動や施設利用の前には、大学の公式案内も確認してください。

主な機能

  • 施設名、別名、タグによる検索
  • キャンパス・カテゴリによる絞り込み
  • 施設の選択と外部地図リンク
  • 現在地表示と徒歩ルート案内、音声案内、ルート逸脱時の再検索
  • 神戸市バス、JR、阪急電鉄、阪神電鉄、神戸市営地下鉄、ポートライナーの最寄り交通カード
  • キャンパス最寄りのバス停の目安時刻表示と、月次更新の駅方面別時刻表
  • Google Maps APIキー未設定時のフォールバック地図
  • Gitで管理する静的施設データ
  • GitHub Issueによる情報修正の受付
  • カテゴリ別の静的ページ

技術スタック

  • Astro + TypeScript
  • React
  • Google Maps JavaScript API(任意)
  • Vitest

セットアップ

必要な環境はNode.js 22以上です。

git clone https://github.com/I-H-dot/ShindaiMap.git
cd ShindaiMap
npm ci
npm run dev

同梱した静的データとフォールバック地図だけで動作します。ブラウザでhttp://localhost:4321を開いてください。 交通カードのバス発車時刻は目安です。電車は生成済みの月次時刻表データがある方面だけアプリ内に表示し、未取得の方面は公式時刻表リンクへ誘導します。

環境変数

変数 必須 用途
SITE_ORIGIN 本番のみ canonical URLとサイトマップの生成元
PUBLIC_GOOGLE_MAPS_API_KEY 任意 Google Maps JavaScript API

Google Mapsを表示する場合だけ、.env.example.envへコピーしてAPIキーを設定してください。

データ更新

公式地図番号、AED、画像由来POI、交通拠点の座標はsrc/data/*.jsonで管理し、TypeScript側でアプリ用データへ変換します。鉄道時刻表はnpm run scrape:train-timetablessrc/data/generated/trainTimetables.tsを生成します。変更後はnpm run checkを実行してください。データの出典と取り扱いはdata/README.mdを参照してください。

検証

npm run check

このコマンドでテスト、型チェック、静的ビルドを実行します。CIでも同じ検証を行います。

デプロイ

mainブランチへプッシュすると、GitHub ActionsがGitHub Pagesへ自動デプロイします。

公開先はhttps://i-h-dot.github.io/ShindaiMap/です。初回だけGitHubリポジトリのSettings > Pages > Build and deployment > SourceGitHub Actionsを選択してください。

Google Maps APIキーを設定しなくてもフォールバック地図で動作します。公開手順と任意のGoogle Maps設定はdocs/DEPLOYMENT.mdを参照してください。

コントリビューション

IssueやPull Requestを歓迎します。作業前にCONTRIBUTING.mdCODE_OF_CONDUCT.mdを確認してください。脆弱性は公開IssueではなくSECURITY.mdの手順で報告してください。

公開リポジトリへ切り替える前に、メンテナーはdocs/PUBLISHING.mdのチェックリストも確認してください。

ライセンス

ソースコードはMIT Licenseで公開します。施設名、出典元コンテンツ、商標などの第三者権利はMIT Licenseの対象ではありません。詳細はdata/README.mdを参照してください。

About

Unofficial open-source campus map for Kobe University.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors