该存储库包含一个 Web 和跨平台应用程序(Web PWA、Windows、Mac OS X、iOS 和 Android),可轻松生成账单。该项目应有助于维护客户数据、开具发票/计费……
使用或试用的框架、平台、库、插件、概念、架构、技术......如下:
该项目需要预先安装以下依赖项:
要安装所有需要的依赖项,只需运行:
npm install
这还设置了 git 提交消息模板(并将 wip 包设置为使用 commitizen)。
请在本项目中使用GitFlow分支模型和 SourceTree 分支的默认名称,更多信息可以在此处找到:
在这个项目中(角度)传统提交使用了角度提交消息指南。
它们将用于使用 npm 包standard-version自动生成变更日志,只需运行npm run release
即可。这将执行以下任务:
您可以使用npm run commit
获取一个向导,帮助您编写正确的提交消息(这是通过commitizen完成的)。
此外,将使用commitlint检查提交消息是否正确(如果您确实需要跳过它,您可以绕过 githooks,但通常不应该这样做)。
您可以使用npm run prepare-git-commit-template
生成 git 提交消息模板,这也将在 npm 安装期间完成。
标题(由type 、 range和subject组成)不应超过 72 个字符。
type(scope?): subject
body?
footer?
必须是以下之一:
src
或test
文件的其他更改范围可以是指定提交更改位置的任何内容。我使用以下约定(示例):
主题包含更改的简洁描述:
正如在主语中一样,使用祈使式、现在时:“change”而不是“changed”或“changes”。正文应包括改变的动机,并将其与以前的行为进行对比。
页脚应包含有关重大更改的所有信息,也是引用此提交关闭的 JIRA 问题的位置。
重大变更应以BREAKING CHANGE:
带有一个空格或两个换行符。然后,提交消息的其余部分将用于此目的。
在此存储库中,使用 git hooks(使用husky设置)来检查“干净”的源代码。
如果 Typescript 或 SCSS 文件发生更改并推送,则会触发提交钩子,并且暂存文件的格式会更漂亮。它在Pretty-quick的帮助下进行格式化/更改并提交和推送这些更改。
检查 git 提交消息是否是常规 git 提交消息,否则将取消提交。
发布分支上的最后一次提交应该设置项目版本并生成变更日志,这应该通过npm run release
完成。该集是项目版本,生成更改日志并提交此更改。更多信息可以在以下章节中找到:常规变更日志/提交
在这个项目中, Travis CI设置为 lint-、test-、e2e-tests- 和 build-slave。如果一切都经过测试并成功构建,Travis CI 会将WebApp部署到FireBase 。