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