給公司工程師參考撰寫專案說明文件Readme範本,工程師撰寫專案Readme 文件,可以參考此文件或直接複製此文件,並修改符合專案的說明。
- 為了讓每個工程師都能輕鬆與快速上手其他工程師的程式碼,需要每個工程師配合撰寫此文件
- 可以複製此檔案至自己要開發的專案根目錄
- 本文件讓公司內的工程師撰寫建置與部署文件時,皆可以參考複製並更改
- 可以參考如下方式撰寫專案建置與說明文件,與該專案維護與運行時注意事項。
- Core 資料夾專門放主要商業行為邏輯,共用的專案。
- DataAccess 資料夾專門放與資料庫相關的處理專案
- Solution Items 資料夾專門放方案檔的說明,README.md
- Test 資料夾專門放測試專案,README.md
- Web 資料夾專門放Web,Web Api專案,README.md
專案名稱 | 說明 | 備註 |
Binodata.QQOO.Member.Web | 娃娃機會員雲端管理系統專案 | |
Binodata.QQOO.Admin.Web | 娃娃機裝置管理系統專案 | |
Binodata.IoT.Library | 系統所需要使用的專案 | 於另一個Git儲存庫,[連結](url) |
- 資料庫環境: SQL Server 2014
- 開發環境 Visual Stdio 2015
- 在方案上按下滑鼠右鍵,選擇 Restore Nuget Packages
- 於Binodata.Intra 中檢查 web.config 的 連線字串
<connectionStrings>
<add name="XXXConnection" connectionString="Data Source=localhost;Initial Catalog=XXX;Persist Security Info=True;User ID=sa;Password=1234567890;Connection Timeout=300;" providerName="System.Data.SqlClient" />
</connectionStrings>
- 確定資料庫連線字串是否可以連線
- 確定資料庫連線的使用者權限是否擁有可以Create DB, Table的權限
- 設定正確的連線字串
- 建置
- Run
- 若沒有對應資料庫,資料庫與資料表格會自行產生(Entity Framework Code First 的作用)
- Compile 失敗。
- 處理方式: Nuget Restore
- System.Data.SqlClient.SqlException: 資料庫中已經有一個名為 'XXX' 的物件
- 處理方式: 刪除資料庫
- 沒有足夠的權限建立資料庫
- 處理方式 : 給予連線的使用者於資料庫中擁有Create db, table 的權限
- 資料庫: AWS RDS
- 主機: AWS EC2 (Windows Server 2012)
- 專案套件皆使用Nuget套件統一管理
- 若需要詳細版本,請參閱個專案的packages.config
- AutoComplete.js
- 取得Binodata 服務資料的Web API 的URL
http://localhost/service/api/binodata/binoserver
- 回傳Json資料範例
[
{
"ServiceCode": 1,
"ServicName": "BinodataMath"
},
{
"ServiceCode": 2,
"ServicName": "BinodataDB"
},
{
"ServiceCode": 3,
"ServicName": "BinodataCloud"
}
]
- 加法計算
- 回傳計算結果
int c = Calculator.Add(a, b);