docman

Docman

文檔管理應用程序

介紹

• DocMan是一種文檔管理系統，可使用RESTFUL API公開端點。
• 它具有以下功能：
  • 登入
  • 報名
  • 查找一個用戶
  • 查找所有用戶
  • 搜索文檔
  • 搜索用戶
  • 創建文檔
  • 刪除文檔，用戶
  • 更新文檔，用戶
• 可以在這裡找到API文檔

項目依賴性

依賴性

• babel -cli-允許以ES6模式運行該應用，而無需將其轉移到ES5
• babel-preset-es2015 ， babel-preset stage-0-這些包裝為ES2015插件提供了預設，階段0插件
• bcryptjs-用於哈希密碼
• Body -Parser -Node.js身體解析中間件。在您的處理程序之前，在req.body屬性下可用的中間件中的中間件中的傳入請求機構。
• dotenv-加載環境變量
• Express-用作此應用程序的Web服務器
• jsonwebtoken-生成JWT令牌並可以驗證它們
• pg- node.js的非阻滯postgresql客戶端純JavaScript和可選的本機LIBPQ綁定
• semelize -nequelize是Postgres，MySQL，SQLite和Microsoft SQL Server的基於承諾的node.js orm。它具有可靠的交易支持，關係，閱讀複製等等

發展依賴性

• Chai -Chai是一個用於節點的BDD / TDD斷言庫，也可以與任何JavaScript測試框架配對。
• CoverAlls -Cossalls.io支持Node.js。獲取Coveralls.io的覆蓋範圍報告，並在您的自述中添加一個涼爽的覆蓋範圍按鈕。
• Gulp -Gulp是一種工具包，可幫助您在開發工作流程中自動化痛苦或耗時的任務。
• GULP -BABEL-今天與Babel一起使用下一代JavaScript
• Gulp-Impoxt-Modules-將JavaScript文件從Gulp流加載到Node的模塊加載程序中。
• 伊斯坦布爾- 生成測試覆蓋範圍
• Gulp產卵 - 摩卡- 從Gulp致電Mocha-cli
• 摩卡咖啡- JavaScript測試框架
• Gulp -Nodemon-是Gulp + Nodemon +便利性
• quelize -cli-續集命令行接口（CLI）
• Supertest -HTTP主張通過Superagent輕鬆。

安裝和設置

• 使用您喜歡的terminal導航到目錄。

• 克隆該存儲庫到該目錄。

• 使用SSH; $ git clone [email protected]:andela-obamidele/docman.git

• 使用HTTP; $ git clone https://github.com/andela-obamidele/docman.git

• 導航到倉庫目錄

• $ cd document-manager

• 安裝應用程序的依賴項

• $ npm install

• 運行應用程序

• $ npm start

測試

• 測試是使用Supertest Chai編寫的。
• 測試覆蓋範圍由istanbul軟件包生成
• 要運行測試，請導航到項目的根目錄
• 運行以下命令。
• $ npm test

如何貢獻

為了做出貢獻，必須遵循某些指南和样式指南。有關倉庫的Wiki，請提供更多信息。
為了做出貢獻，請將此存儲庫分配給您的私人存儲庫，並根據要添加的功能創建拉動請求。

免責聲明

該應用程序及其功能受時間限制的限制，絕不是最好的。

常見問題解答

• 我如何為這個項目做出貢獻
  • 閱讀Wiki
  • 分叉存儲庫並在dobe時提出拉動請求
• 支持此API多長時間
  • 只要有用戶
• 我如何報告錯誤
  • 提出一個問題，告訴您您在發生錯誤時要做什麼
  • 和錯誤消息

執照

存儲庫中包含的許可證

作者

Olufisayo Bamidele