Skip to content

moda-gov-tw/opendata-frontend

Repository files navigation

政府資料開放平臺前端

image image image image

簡介

本專案為政府資料開放平臺前端開源,透過開源程式提供政府機關或民間團體,共同為政府開放資料盡一份心力。

本平臺採用 Vue.js 框架開發,使用了 Nuxt.js 框架進行 SSR(Server Side Rendering) 的開發,開發語言則使用了 TypeScript,並以 element-plus 作為UI框架,另外,也通過了無障礙網路空間服務網的 (Accessibility) 的 Freego 測試。

開發環境&安裝

本專案開發環境和本專案主要有用到的套件如下:

建議使用 vscode 作為開發工具,並能安裝 vue 相關套件來做輔助。

安裝

git clone 下來後,新增 .env 檔案(內容可參考 .env.example),.env 中可設定目前的環境變數,

NUXT_ENV 為使用者目前的環境階段,預設為 development,

NUXT_PUBLIC_BASE_URL 和 NUXT_API_URL 則能設定前台的網址和API的呼叫網址,

WEBSITE_NAME 和 WEBSITE_DESCRIPTION 則是設定網站的名稱和網站的描述。

然後於專案目錄下執行以下指令:

npm install
npm run dev

http://localhost:3000/ 即可看到本專案的前台畫面。

專案說明

本專案的主要目錄結構如下:

assets - 放置靜態資源,如圖片、CSS樣式表等

components - 放置 Vue 元件

composables - 放置 Vue 元件的邏輯

layouts - 放置頁面的版型

middleware - 放置中介層

pages - 放置頁面

public - 放置公開的靜態資源,如 favicon.ico

server - 放置於 nuxt 伺服器端的程式碼

License

本專案使用了 MIT License

本專案有使用到的套件:

Name License Description
Vue.js MIT 本專案使用的前端框架
Nuxt.js MIT 本專案使用的 Vue SSR 框架
Pinia MIT 於 Vue 專案中的狀態管理工具
TypeScript Apache-2.0 本專案使用的程式語言
Chart.js MIT 於本專案所使用的圖表工具套件
Vuewordcloud MIT 本專案使用的文字雲套件
Vue router MIT 讓Vue建立SPA和路徑的跳轉
@Element-plus/nuxt MIT 本專案使用的Vue UI framework
@nuxt/devtools MIT 提供nuxt工具,幫助開發者開發
@nuxt/images MIT 提升網站於nuxt專案的圖片顯示效能
eslint MIT 檢查並改善專案中的程式碼撰寫方式
prettier MIT 檢查並改善專案中的程式碼排版和顯示

備註

本專案為政府資料開放平臺前端開源示範案例,議題(Issues)處理範圍為程式錯誤(Bug),版本更新則以系統改版等重大變更為主。

About

政府資料開放平臺前端

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages