README

关于 Open Payroll

Open Payroll 是一个用于工资系统的开源项目 - 这意味着您可以获取代码以用于您现有的 Laravel 应用程序。

以下是一些提供的功能

• 基于组织或员工的多项收入和扣除
• 使用工资调度器自动计算工资
• 每个工资单至少需要一名审查员和一名审批人
• 可定制的工资条设计
• 通过电子邮件/导出工资条给员工
• 管理员工资报告
• 员工工资报告
• 自定义收入和扣除
• 可定制的收入和扣除计算流程

演示网站

您可以在 这里 查看演示。

安装

1. 为了在您的 Laravel 项目中安装 cleaniquecoders/open-payroll，只需从您的终端运行 composer require 命令即可

$ composer require cleaniquecoders/open-payroll

1. 如果您正在运行 Laravel 5.6 或更高版本，可以跳过此步骤。然后在您的 config/app.php 中将以下内容添加到 providers 数组中

CleaniqueCoders\OpenPayroll\OpenPayrollServiceProvider::class,

1. 如果您正在运行 Laravel 5.6 或更高版本，可以跳过此步骤。在同一 config/app.php 中将以下内容添加到 aliases 数组中

'OpenPayroll' => CleaniqueCoders\OpenPayroll\OpenPayrollFacade::class,

1. 如果您正在运行 Laravel 5.8 或更高版本，您需要修改用户表迁移。

// Change:
$table->bigIncrements('id');

// To:
$table->increments('id');

1. 接下来，您需要安装 Open Payroll 资产

$ php artisan open-payroll:install
$ php artisan migrate

1. Open Payroll 使用 Laravel Observer，因此您需要发布 Laravel Observers 配置文件。

$ php artisan vendor:publish --tag=laravel-observers

然后，将 Open Payroll 模型添加到 config/observers.php 中的 \CleaniqueCoders\LaravelObservers\Observers\HashidsObserver::class 键。这将允许观察器自动为每条记录创建哈希短网址。

return [
    \CleaniqueCoders\LaravelObservers\Observers\ReferenceObserver::class => [],
    \CleaniqueCoders\LaravelObservers\Observers\HashidsObserver::class   => [
    	\App\Models\OpenPayroll\Employee::class,
    	\App\Models\OpenPayroll\Position::class,
    	\App\Models\OpenPayroll\Salary::class,
    	\App\Models\OpenPayroll\Admin::class,
    	\App\Models\OpenPayroll\Payroll::class,
    	\App\Models\OpenPayroll\Payslip::class,
    	\App\Models\OpenPayroll\Earning::class,
    	\App\Models\OpenPayroll\Deduction::class,
    ],
];

您还可以将观察器用于其他模型。

然后为 Open Payroll 种植引用数据

$ php artisan open-payroll:seed

使用

完成安装过程后，您可以登录到您的应用程序。

测试

要运行测试，请从您的终端输入 vendor/bin/phpunit。

为了获取代码覆盖率，请确保安装 PHP XDebug，然后运行以下命令

$ vendor/bin/phpunit -v --coverage-text --colors=never --stderr

贡献

感谢您考虑为 cleaniquecoders/open-payroll 做出贡献！

错误报告

为了鼓励积极的协作，强烈鼓励提出拉取请求，而不仅仅是错误报告。错误报告也可以以包含失败测试的拉取请求的形式发送。

然而，如果您提交错误报告，您的问题应包含标题和对问题的清晰描述。您还应尽可能提供尽可能多的相关信息和一个演示问题的代码示例。错误报告的目的是使您自己和他人能够轻松地复制错误并开发解决方案。

请记住，错误报告是在希望有相同问题的其他人能够与您合作解决问题的情况下创建的。不要期望错误报告会自动看到任何活动或其他人会立即修复它。创建错误报告的目的是帮助您自己和他人开始解决问题的道路。

编码风格

cleaniquecoders/open-payroll 遵循 PSR-2 编码标准和 PSR-4 自动加载标准。

您可以使用 PHP CS Fixer 来保持标准化。PHP CS Fixer 配置可以在 .php_cs 中找到。

许可证

本软件包是开源软件，遵循MIT许可协议。