bizley / timeclock
简单的工时记录项目
2.4.1
2020-12-14 13:08 UTC
Requires
- php: >=7.1
- ext-mbstring: *
- npm-asset/air-datepicker: ^2.2
- npm-asset/fortawesome--fontawesome-free: ^5.6
- yiisoft/yii2: >=2.0.15.1 <2.1.0
- yiisoft/yii2-bootstrap4: ^2.0
- yiisoft/yii2-swiftmailer: ^2.0
Requires (Dev)
- phpunit/phpunit: >=7.5
- roave/security-advisories: dev-master
- yiisoft/yii2-debug: ^2.0
README
基于 Yii 2 框架 的简单工时记录服务。
安装
-
使用 Composer 安装 TimeClock
composer create-project --prefer-dist bizley/timeclock timeclock
-
准备指向
/public
目录的虚拟主机。 -
准备你选择的数据库配置。将其放在
/src/config/db.php
。 -
修改
/src/config/web.php
文件以更改timeZone
(默认UTC
),language
(默认en-US
;pl
和de
翻译提供在/src/messages/
文件夹中),components > mailer
配置以实际发送电子邮件(用于密码重置),components > formatter
日期和时间格式配置,params > company
(默认公司名称
;在页脚和其他布局位置显示),params > email
(默认email@company.com
;用作电子邮件发送者地址),params > allowedDomains
(默认['@company.com']
;允许注册的电子邮件域数组)。
-
将
/public/index.php
文件更改为将YII_DEBUG
模式设置为false
和YII_ENV
环境设置为prod
。 -
在控制台中运行
php yii migrate
以应用迁移。 -
启动 web 服务器并注册第一个账户。
-
如果您想创建一个管理员账户,请在控制台中运行
php yii admin/set ID
,其中ID
是要设置的账户的数据库标识符(通常是第一个1
)。
基本规则
- 注册账户需要其电子邮件地址位于提供的域之一。如果您想更改此行为,您必须准备自己的代码。当前实现位于
/src/models/RegisterForm.php
和/src/views/site/register.php
。 - 会话可以在任何时候开始,但必须结束,不得与其他结束的会话重叠。
- 一天中可以有多个会话。
- 会话不能超过午夜。
- 未结束的会话不计入工作时间。
- 休息时间不能与其他休息时间重叠。
- 假期自动从
https://www.kalendarzswiat.pl
获取,该网站是波兰假日列表。如果您想使用其他内容,您必须为此准备自己的代码。当前实现位于/src/models/Holiday.php
。
功能
- 账户注册
- 密码重置
- 更新个人资料
- 主题
- 使用登录名或 PIN 登录
- 会话时间带备注
- 休息时间带备注
- 会话和休息时间历史记录
- 日历
- 假期
- 管理员部分
- REST API
- Bootstrap 4 布局
2.3.0 中的新功能
- 休假请求
- 项目
- 为管理员提供会话时间 CSV 下载
- 管理员停用账户
从 2.2.1 升级到 2.3.0
- 更新所有项目文件以匹配存储库。
- 在控制台中运行
php yii migrate
以应用迁移。
一般帮助
首先阅读 TimeClock Wiki。
有关与 Yii 相关的所有内容,请参阅 Yii 2 指南。
我真的不想指向那些显然带有解决方案的链接。
本项目使用方法
只要提及来源,您可以使用本项目以任何您喜欢的方式。