/README-Example-Template

README 撰寫範本

｜｜｜

由於許多人都不知道如何撰寫 README，所以我就提供一個 README 範本，讓大家可以參考，許多地方你都可以斟酌是否要加入，或是修改成你自己的風格。

ps. 底下範本不是絕對，你可以依照自己需求斟酌增加或刪除。

README Template

專案封面圖

此專案是一份 README 的撰寫範本，主要是方便所有人可以快速撰寫 README，讓大家可以更有方向的去寫出 README。

功能

測試帳號密碼 （請斟酌提供，建議只提供僅能觀看不能操作的帳號密碼）

帳號： example@example.com
密碼： example
  • 登入
  • 登出
  • 產品列表 ...

畫面

可提供 1~3 張圖片，讓觀看者透過 README 了解整體畫面

範例圖片 1 範例圖片 2 範例圖片 3

安裝

請務必依據你的專案來調整內容。

以下將會引導你如何安裝此專案到你的電腦上。

Node.js 版本建議為：16.15.0 以上...

取得專案

git clone git@github.com:hsiangfeng/README-Example-Template.git

移動到專案內

cd README-Example-Template

安裝套件

npm install

環境變數設定

請在終端機輸入 cp .env.example .env 來複製 .env.example 檔案，並依據 .env 內容調整相關欄位。

運行專案

npm run serve

開啟專案

在瀏覽器網址列輸入以下即可看到畫面

http://localhost:8080/

環境變數說明

APIPATH= # API 位置
COUSTOMPATH= # 自訂變數
...

資料夾說明

  • views - 畫面放置處
  • controllers - 控制器放置處
  • modules - 模組放置處
  • assets - 靜態資源放置處
    • scss - scss 檔案放置處
    • images - 圖片放置處 ...

專案技術

  • Node.js v16.15.0
  • Vue v3.2.20
  • Vite v4.0.4
  • Vue Router v4.0.11
  • Axios v0.24.0
  • Bootstrap v5.1.3 ...

第三方服務

  • Algolia
  • Google Analytics ...

CI/CD 說明

此專案有使用 Github Actions，所以發起 PR 時會自動執行以下動作：

  • 建立 Node.js 環境
  • 安裝相依套件
  • 編譯程式碼
  • 執行 ESLint 掃描
  • 執行測試 ...

當專案 merge 到 main 時會自動執行以下動作：

  • 建立 Node.js 環境
  • 安裝相依套件
  • 編譯程式碼
  • 執行 ESLint 掃描
  • 執行測試
  • 部署到 Github Pages ...

聯絡作者

ps. 這邊絕對不是業配，而是要適當提供一些方式讓觀看者知道你的聯絡方式，讓他們可以更方便的找到你。

你可以透過以下方式與我聯絡