Skip to content
This repository has been archived by the owner on Nov 5, 2020. It is now read-only.

Latest commit

 

History

History
147 lines (103 loc) · 4.15 KB

README.md

File metadata and controls

147 lines (103 loc) · 4.15 KB

ExpenseClaimAutomationSystem Monorepo


Build Status Codacy Badge GitHub license GitHub release

简介

大数据时代下的财务自动化报销系统,2019 年国家大学生创新创业训练计划创新训练子计划项目

生产地址

快速开始(后端)

开发环境

  • Python>=3.5
  • PostgreSQL>=10
  • Django>=2.0
pip3 install virtualenv
virtualenv env
source env/bin/activate # source env/Scipts/activate
pip install -r requirements.txt
pip install -r dev-requirements.txt
ENV=dev python manage.py makemigrations
ENV=dev python manage.py migrate
✨🍰✨

测试

ENV=test python manage.py test(make test)
isort --recursive -c -df .(make check)
yapf --recursive --diff .(make check)

启动服务

ENV=dev python manage.py runserver(make dev)

快速开始(前端)

使用yarn作为包管理工具的,需先在本地安装yarn

npm install
npm run serve

or

yarn install
yarn serve

开发规范

开发流程

按照Github-flow进行开发,即:

  1. master分支上 checkout 出一条新分支
  2. 新分支开发完成后,向 master 发起一个pull request
  3. 大家一起 review 你的代码,不断修改和提交代码
  4. pull request被接受,合并进 master

代码提交

发起 pull request 前,务必通过下述命令将其 rebase 至最新的 master 分支上:

git fetch origin
git rebase origin/master
git push origin

后端:使用 flake8,yapf,isort 进行风格检查,commit 代码前,务必使用下述指令对代码进行格式化(make format)

isort -rc .
yapf --recursive -i .

前端: #Todo

代码风格

分支命名

存在一个长期分支 master,其余分支命名规则如下,多个单词之间以-风格,如无对应 issue 可省略 issue id:

  • feature/{issue id}/*(例:feature/1/add-teacher 或 feature/add-teacher)
  • fix/{issue id}/* (例:fix/2/fix-travis-ci 或 fix/fix-travis-ci)
  • patch/*
  • issues/{issue id}/*

Commit Message

<type>(<scope>): <subject>
<空行>
<body>
<空行>
<footer>

推荐使用commitizen来格式化 commit message

开源协议 & 作者