# 違章建築檢舉輔助系統 開發文件

<span style="color: red !important; font-size: 2em;">移到 https://g0v.hackmd.io/FZFghtuoQ0aaGIl9xXzuKw</span>

## 專案目的

建立一個方便的舉報違章建築的系統
舉報完會自動轉換成實際舉報所需資料並產生公文
方便地球公民基金會做後續向政府舉報的動作

## 階段
1. ==now== 建立蒐集資料系統
2. 匯入已知的違章工廠資料
4. 提供給地球公民基金會使用的後臺
5. 背後轉換成公文
6. 串接 Bot 做到完全匿名

## 開發需求
- 前後端分離
- 前端 (1 位)
- Vue.js
- OpenLayers
- 地圖顯示的套件
- 國土測繪圖資服務雲用同一套方便作業
- TypeScript
- 後端 (1-2 位)
- 程式語言
- Node.js
- Modern PHP
- Python
- 由最後負責後端的人討論決定
- 資料庫
- PostgreSQL
- 有內建強大的地理查詢能力
- SQLite
- 聽說跟 PostgreSQL 地理部分用同套 Lib
- MariaDB
- 單純比較熟悉
- 由最後負責後端的人討論決定
- 簡單爬蟲能力
- 可能需要分析國土測繪圖資服務雲的 API

## API

- 工廠資料
- 使用者上傳
- 國土舊有資料 (ronny wang 農地和工廠經緯度: [full-info.csv](https://gist.github.com/ronnywang/f8bbf008e641b296c755f0167b51a550))

- ==1== GET `/factories?lng={lng}&lat={lat}&range={km}`
- 得到中心座標往外指定範圍的已有工廠資料
- response

        Array<{
          id: number,
          lng: number,
          lat: number,
          name: string,
          type: Enum, // 工廠類型
          images: [{
            id: number,
            url: string,
            alt: string
          }]
          report_at?: number // 回報日期
          status: Enum // 已回報 | 編輯中 | ... (TBD)
          // post_process: string
        }>

> 還缺公文回報內容（照片）
> 舊的違章工廠資料：地號中心點座標
> 新增違章工廠資料：使用者定位 GPS
> 需要確認一下國土規劃的 API 有提供到多少的地段地號轉座標與多邊形
> post_process 用 html or markdown

- ==2== PUT `/factories/{id}/{attribute}`
- 新增編輯指定 id 的工廠欄位資料
- request

        {
          value: string
        }

> 要有編輯紀錄
- ==3== POST `/factories/{id}/images`
- 上傳指定 id 的工廠圖片
- ==4== POST `/images`
- 上傳圖片
- response

        { token: string }

- ==5== POST `/factories`
- 新增工廠
- request

        {
          name: string,
          type: Enum,
          images: string[],
          other: string,
          lat: number,
          lng: number
          nickname: string,
          contact: string
        }

> 少舉報人的聯絡方式（只有新增的時候會問）：稱呼 & 聯絡方式（電話號碼或 email）

PS. 少了新增聯絡方式的流程 所以暫時沒設計相關 API

> 還有地球公民基金會後台的 API 還沒開

## 其它連結

- Firebase 相關，可能可以拿來處裡 Geo 資料
- https://github.com/geofirestore/geofirestore-js
- https://angularfirebase.com/lessons/geolocation-query-in-firestore-realtime/
- https://firebase.google.com/docs/reference/android/com/google/firebase/firestore/GeoPoint