develop

.github/copilot-instructions.md

@@ -5,6 +5,7 @@ Always reference these instructions first and fallback to search or bash command
 ## Working Effectively
 
 ### Environment Setup
+
 - **Node.js**: MUST use version 22.14.0 (specified in `mobile-app/.nvmrc`)
   - Install: `curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash`
   - Setup: `export NVM_DIR="$HOME/.nvm" && [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"`
@@ -17,19 +18,21 @@ Always reference these instructions first and fallback to search or bash command
 ### Bootstrap and Build Process
 
 #### Complete OpenAPI Generation Workflow
+
 - **NEVER CANCEL**: Full workflow takes ~3 minutes. Set timeout to 5+ minutes.
 - Command: `./generate-openapi.sh` (from repository root)
 - This script orchestrates:
   1. Go dependencies installation (~20 seconds)
   2. Swagger 2.0 generation via `swag init` (~1 second)
-  3. OpenAPI 3.0.3 conversion (~1 second)
-  4. npm install for mobile app (~2 minutes)
+  3. npm install for mobile app (~2 minutes)
+  4. OpenAPI 3.0.0 conversion (~1 second)
   5. TypeScript schema generation (~1 second each)
   6. Mock server validation (~1 second)
 
 #### Go API Development
+
 - **Dependencies**: `cd api && go mod tidy` (~20 seconds)
-- **Generate docs**: `cd api && swag init` (~1 second) 
+- **Generate docs**: `cd api && swag init` (~1 second)
 - **Build**: `cd api && go build -o api-server main.go` (~8 seconds)
 - **Run**: `cd api && ./api-server` (starts on port 8080)
 - **Test**: Available endpoints:
@@ -38,25 +41,28 @@ Always reference these instructions first and fallback to search or bash command
   - Posts endpoints may fail in sandboxed environments (expected)
 
 #### Mobile App Development
+
 - **ALWAYS use Node.js 22.14.0**: `nvm use 22.14.0` before any npm commands
 - **Dependencies**: `cd mobile-app && npm ci` (~15 seconds)
 - **Development server**: `cd mobile-app && npx expo start` (~5 seconds to start)
   - QR code for mobile testing
   - Web development available but has known limitation with react-native-maps
-- **Schema generation**: 
+- **Schema generation**:
   - Example: `npm run gen-schema:example` (~1 second)
   - API: `npm run gen-schema` (~1 second)
 
 ### Validation and Testing
 
 #### Linting and Formatting - NEVER CANCEL: Run all before committing
+
 - **Mobile app directory linting**: `cd mobile-app && npm run ls-lint` (~1 second)
-- **ESLint**: `cd mobile-app && npm run lint` (~4 seconds)  
+- **ESLint**: `cd mobile-app && npm run lint` (~4 seconds)
 - **Prettier check**: `cd mobile-app && npm run format:check` (~1 second)
 - **TypeScript checking**: `cd mobile-app && npm run test:ts` (~4 seconds)
 - **Root directory linting**: `npx @ls-lint/ls-lint` (~1 second)
 
 #### Mock Server Testing
+
 - **Start mock**: `cd mobile-app && npm run mock` (port 8080)
 - **Test endpoints**:
   - `curl http://localhost:8080/health` (returns {})
@@ -66,25 +72,29 @@ Always reference these instructions first and fallback to search or bash command
 ### Known Limitations and Workarounds
 
 #### Web Build Limitation
+
 - **Issue**: `expo export --platform web` fails due to react-native-maps importing native modules
 - **Workaround**: This is expected behavior. App has platform-specific files:
   - `maps.tsx` - Web fallback (displays text message)
   - `maps.native.tsx` - Native implementation (full map functionality)
 - **Development**: Use `npx expo start` for mobile development (works perfectly)
 
 #### External API Dependencies
+
 - Posts endpoints (`/api/v1/posts`) depend on jsonplaceholder.typicode.com
 - In sandboxed environments, these will return error responses (expected behavior)
 - Health endpoint always works for testing API functionality
 
 ### Timeout Values and Timing Expectations
 
 #### NEVER CANCEL - Critical Build Operations
+
 - **Complete OpenAPI workflow**: 5+ minutes timeout (includes npm install)
 - **npm ci**: 3+ minutes timeout (includes dependency resolution)
 - **go mod tidy**: 2+ minutes timeout (first time, includes downloads)
 
 #### Quick Operations (under 30 seconds)
+
 - Individual linting/formatting checks: 30 seconds timeout
 - Schema generation: 30 seconds timeout
 - Go builds: 30 seconds timeout
@@ -93,14 +103,16 @@ Always reference these instructions first and fallback to search or bash command
 ### Manual Validation Scenarios
 
 #### Complete API Workflow
+
 1. Generate OpenAPI specs: `./generate-openapi.sh`
 2. Start API server: `cd api && ./api-server`
 3. Test health endpoint: `curl http://localhost:8080/api/v1/health`
 4. Verify Swagger UI loads: `curl http://localhost:8080/swagger/index.html`
 5. Stop server and start mock: `cd mobile-app && npm run mock`
 6. Test mock endpoints: `curl http://localhost:8080/posts`
 
-#### Complete Mobile App Workflow  
+#### Complete Mobile App Workflow
+
 1. Ensure Node.js 22.14.0: `nvm use 22.14.0`
 2. Install dependencies: `cd mobile-app && npm ci`
 3. Generate schemas: `npm run gen-schema:example && npm run gen-schema`
@@ -109,6 +121,7 @@ Always reference these instructions first and fallback to search or bash command
 6. Verify QR code and mobile development options appear
 
 ### CI/CD Integration
+
 - GitHub Actions configured with 60-minute timeouts (appropriate)
 - Mobile app workflow: schema generation, linting, formatting, type checking
 - Project workflow: OpenAPI generation and validation
@@ -117,19 +130,22 @@ Always reference these instructions first and fallback to search or bash command
 ### Important File Locations
 
 #### Configuration Files
+
 - `mobile-app/.nvmrc` - Required Node.js version (22.14.0)
 - `mobile-app/package.json` - Mobile app dependencies and scripts
 - `api/go.mod` - Go dependencies
 - `.ls-lint.yml` - Directory structure linting rules
 - `generate-openapi.sh` - Complete OpenAPI workflow script
 
 #### Generated Files (Do Not Edit)
+
 - `api/docs/swagger.json` - Generated Swagger 2.0 specification
-- `openapi-specifications/api.swagger.json` - Generated OpenAPI 3.0.3 specification  
+- `openapi-specifications/api.swagger.json` - Generated OpenAPI 3.0.0 specification
 - `mobile-app/schema/api.d.ts` - Generated TypeScript definitions
 - `mobile-app/schema/example.d.ts` - Generated example TypeScript definitions
 
 #### Key Source Directories
+
 - `api/` - Go API server with Gin framework
 - `mobile-app/app/` - React Native app with Expo Router
 - `mobile-app/components/` - Reusable UI components with Gluestack-UI
@@ -138,16 +154,19 @@ Always reference these instructions first and fallback to search or bash command
 ### Troubleshooting Common Issues
 
 #### "Module not found" errors in mobile app
+
 - Ensure Node.js 22.14.0: `nvm use 22.14.0`
 - Regenerate schemas: `npm run gen-schema:example && npm run gen-schema`
 - Clear cache: `npx expo start --clear`
 
 #### Go build failures
+
 - Generate swagger docs first: `cd api && swag init`
 - Install swag tool: `go install github.com/swaggo/swag/cmd/swag@latest`
 - Ensure PATH includes Go bin: `export PATH=$PATH:$(go env GOPATH)/bin`
 
 #### Web bundle failures with react-native-maps
+
 - This is expected behavior due to native module imports
 - Use mobile development workflow instead: `npx expo start` (without web)
-- App automatically uses platform-specific map implementations
+- App automatically uses platform-specific map implementations

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "cSpell.words": [
+    "charimachi"
+  ]
+}

Makefile

@@ -0,0 +1,16 @@
+.PHONY: run
+
+run_api_dev:
+	cd api && go mod tidy && \
+	( \
+		kill -9 $$(lsof -ti :8080 2>/dev/null) 2>/dev/null; \
+		trap 'echo "SIGINT received, killing server..."; kill -9 $$(lsof -ti tcp:8080 2>/dev/null) 2>/dev/null; exit' INT; \
+		go run . & \
+		sleep 2; \
+		(open http://localhost:8080/swagger/index.html || xdg-open http://localhost:8080/swagger/index.html); \
+		wait \
+	)
+
+
+run_mobile_app:
+	cd mobile-app && npm install && npm start

README.md

@@ -1,10 +1,39 @@
-# ChariMachi
+# CHARIMACHI
 
-<img src="./img/icon.png" alt="icon" width="200" />
+![CHARIMACHI](./screenshot/thumbnail.png)
+
+<p style="text-align: center;">
+  <img src="./screenshot/marker.png" alt="注位置点表示" width="200" />
+  <img src="./screenshot/score.png" alt="快適度" width="200" />
+</p>
+
+## デモ
+
+<img src="./screenshot/demo.gif" alt="デモ" width="200" />
+
+[動画](https://drive.google.com/file/d/1YiH47TsoH7ZssMZgoyyxL8HFdFj577jk/view?usp=sharing)
 
 ## 概要
 
-自転車の車道通行を目的とした適切なルート提案アプリ
+安全、快適な車道通行ルートを提案する 自転車専用ナビアプリ CHARIMACHI
+
+自転車利用者が安心して車道を走行できるよう支援するナビゲーションアプリを開発しました。自転車での移動を安全かつ快適に走行できるルートを検索・提示し、通行に適した道を優先的に案内します。さらに、交通安全に関する注意喚起として、事故が多発している場所や違反率が高い場所へのピン止めなどをすることで、事故や違反が身近にあるという認識を高め、車道通行の重要性理解を促進します。
+注意喚起をするだけのサービスでは、重要性を理解されていない方々への普及は難しいと考え、日常的につかうナビゲーションアプリとすることで、安全な走行環境を提供しつつ、自転車の車道通行を社会に定着させることを目指します。
+
+## なぜこのサービスを作るのか
+
+車道通行が根付かない要因として、事故や違反が身近にあるという認識が薄く、注意喚起を目にする機会も少ないため、その重要性を十分に理解していないこと、さらに安全に通行できない車道が存在し、安全・快適に自転車を走行できるルートが確認できないことにあると考えました。本サービスではこの二点の課題解決を目指します。
+
+### 安全かつ快適とはどのような道か
+
+- 自転車専用帯が確保されている
+- 歩道内に自転車帯が確保されている
+- 車道の幅が広い
+- 信号待ちの回数が少ない
+- 路駐・路停車が少ない
+- 大型車両の通行量が多くない
+
+(最後2項目は今回実装できないかもしれない要件)
 
 ## 機能
 
@@ -13,11 +42,13 @@
 - 出発地・到着地の候補検索
 - ルート描画
   - 自転車専用帯優先
-  - 取締強化交差点注意(オープンデータ)
   - 信号まち回避
   - 混雑車道回避
+  - 注意喚起
+    - 取締強化交差点注意(オープンデータ)
+    - 事故が多い地点(今回実装を見送る可能性あり)
 - 経由地点表示
-- 動時間表示
+- 所要時間表示
 - about画面・制作元・出典
 - (駐輪所経由モード)
 - (バス停回避モード)
@@ -26,28 +57,46 @@
 
 ### 自転車専用帯優先
 
-- [OpenStreetMap](https://www.openstreetmap.org/)
+- [OpenRouteService](https://openrouteservice.org)
 
 ### 取締強化交差点注意（オープンデータ）
 
 - [東京都オープンデータカタログ - 交通規制情報](https://catalog.data.metro.tokyo.lg.jp/dataset/t000022d1700000024/resource/fb207998-df4c-434c-9280-1d7c2fbfdf1d)
 
+### 違反率別注意交差点(オープンデータ)
+
+- [交通量統計表](https://catalog.data.metro.tokyo.lg.jp/dataset/t000022d0000000035)
+
+    事前にファイル読み込み
+
+    - [（偶数年調査）主要交差点（区部）](https://catalog.data.metro.tokyo.lg.jp/dataset/t000022d0000000035/resource/b315688c-ac19-4b0d-b4be-de6414af7666)
+
+    - [（偶数年調査）主要交差点（多摩部）](https://catalog.data.metro.tokyo.lg.jp/dataset/t000022d0000000035/resource/ddaaa1ac-0d4a-4406-9e7c-f6d66aa74c55)
+
+- [Overpass API](https://overpass-api.de/api/interpreter)
+
+    交通量統計表の交差点ポイントを座標化
+
+
 ### 信号まち回避
 
-- [OpenStreetMap](https://www.openstreetmap.org/)
+- [OpenStreetMap](https://www.openstreetmap.org/) ?
 
 ### 混雑車道回避
 
-- [警視庁 - 交差点区部統計データ](https://www.keishicho.metro.tokyo.lg.jp/about_mpd/jokyo_tokei/tokei_jokyo/ryo.files/02_kousatenkubu_csv.zip)
-- [国土交通省 - 道路統計データ](https://www.mlit.go.jp/road/ir/ir-data/ir-data.html)
+- [警視庁 - 交差点区部統計データ](https://www.keishicho.metro.tokyo.lg.jp/about_mpd/jokyo_tokei/tokei_jokyo/ryo.files/02_kousatenkubu_csv.zip) ?
+- [国土交通省 - 道路統計データ](https://www.mlit.go.jp/road/ir/ir-data/ir-data.html) ?
 
 ### （駐輪所経由モード）
 
-- [東京都オープンデータカタログ - 駐輪場情報](https://catalog.data.metro.tokyo.lg.jp/dataset?q=title%3A+%E9%A7%90%E8%BC%AA%E5%A0%B4&sort=score+desc%2C+metadata_modified+desc)
+- [東京都オープンデータカタログ - 駐輪場情報](https://catalog.data.metro.tokyo.lg.jp/dataset?q=title%3A+%E9%A7%90%E8%BC%AA%E5%A0%B4&sort=score+desc%2C+metadata_modified+desc) ?
 
 ### （バス停回避モード）
 
 - [公共交通オープンデータ - 都営バス停留所データ](https://ckan.odpt.org/dataset/b_busstop-toei/resource/f340278d-aefe-47ea-bc8f-15ebe48c286d)
+
+    必要情報のみ抜き出し加工
+    CC BY 4.0(クレジット明示必要)
 
 ## 構成図
 
@@ -59,6 +108,8 @@ flowchart LR
 
 
     GoServer <--元ルートデータ--> OpenRouteService
+
+    GoServer <--オープンデータ加工--> OpenData
 
 
     ClientApp[クライアントアプリ（Expo）]　--描画--> OSM[OpenStreetMap]
@@ -86,10 +137,6 @@ participant OSM as OpenStreetMap
 
 ---
 
-## template-mobile-app
-
-Templates for mobile app development.
-
 ### [mobile-app](./mobile-app)
 
 This is a template for mobile app development using:
@@ -119,7 +166,7 @@ To generate the OpenAPI definitions, run the following command from the reposito
 This script will:
 
 1. Generate Swagger 2.0 documentation using `swag init` in the API directory
-2. Convert the Swagger 2.0 specification to OpenAPI 3.0.3 format
+2. Convert the Swagger 2.0 specification to OpenAPI 3.0.0 format
 3. Place the result in `openapi-specifications/api.swagger.json`
 4. Verify that React Native type generation and mock server commands work correctly
 

api/.gitignore

@@ -39,3 +39,5 @@ main
 
 # generated files
 docs
+
+.env