README

关于 Open Payroll

Open Payroll 是一个开源的薪资系统倡议 - 这意味着您可以将代码抓取到现有的 Laravel 应用程序中使用。

以下是一些提供的功能

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

演示网站

您可以在这里查看演示。

安装

要安装 cleaniquecoders/open-payroll 到您的 Laravel 项目中，只需在终端运行 composer require 命令

$ composer require cleaniquecoders/open-payroll

如果您的 Laravel 版本为 5.6 或以上，则可以跳过此步骤。然后在您的 config/app.php 文件中，将以下内容添加到 providers 数组中

CleaniqueCoders\OpenPayroll\OpenPayrollServiceProvider::class,

如果您的 Laravel 版本为 5.6 或以上，则可以跳过此步骤。在相同的 config/app.php 文件中，将以下内容添加到 aliases 数组中

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

如果您正在运行 Laravel 5.8 或以上，您需要修改用户表迁移。

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

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

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

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

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许可证许可。

cleaniquecoders / open-payroll

维护者

详细信息