Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cleaniquecoders/attendance
An Adaptive Attendance for Laravel - enabled developers to integrate with existing attendance system and devices such as Access Card, Biometric, etc
https://github.com/cleaniquecoders/attendance
access-card api attendance biometric ble laravel mobile
Last synced: 6 days ago
JSON representation
An Adaptive Attendance for Laravel - enabled developers to integrate with existing attendance system and devices such as Access Card, Biometric, etc
- Host: GitHub
- URL: https://github.com/cleaniquecoders/attendance
- Owner: cleaniquecoders
- License: mit
- Created: 2018-10-02T14:31:01.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2018-10-03T13:43:49.000Z (about 6 years ago)
- Last Synced: 2024-09-21T13:58:54.391Z (about 2 months ago)
- Topics: access-card, api, attendance, biometric, ble, laravel, mobile
- Language: PHP
- Size: 43.9 KB
- Stars: 34
- Watchers: 4
- Forks: 19
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://travis-ci.org/cleaniquecoders/attendance) [](https://packagist.org/packages/cleaniquecoders/attendance) [](https://packagist.org/packages/cleaniquecoders/attendance) [](https://packagist.org/packages/cleaniquecoders/attendance)
## About Your Package
This is an Adaptive Attendance package - enabled developers to integrate with existing attendance system and devices such as Access Card, Biometric, etc.
This package comes with common attendance adapaters:
1. Web Adapter - use for Web based attendance system
2. API Adapter - use for Mobile based attendance system
3. Console Adapter - use for Queue based attendance system
See usage section below for custom adapters.
## Installation
1. In order to install `cleaniquecoders/attendance` in your Laravel project, just run the *composer require* command from your terminal:
```
$ composer require cleaniquecoders/attendance
```
2. Then in your `config/app.php` add the following to the providers array:
```php
CleaniqueCoders\Attendance\AttendanceServiceProvider::class,
```
3. In the same `config/app.php` add the following to the aliases array:
```php
'Attendance' => CleaniqueCoders\Attendance\AttendanceFacade::class,
```
4. Install the package:
```
$ php artisan attendance:install
```
5. Setup `AttendanceTrait` to your user model.
```php
get();
```
To get based on one or more drivers.
```php
\CleaniqueCoders\Attendance\Models\Attendance::todayEntries('web')->get();
\CleaniqueCoders\Attendance\Models\Attendance::todayEntries(['api', 'access-card'])->get();
```
### Custom adapter
You can create custom adapter if you want to have custom integration with Slack, Telegram, etc.
```
$ php artisan make:attendance SlackAdapter --driver=slack
```
This will create a class located at `app/Adapters/SlackAdapter.php`.
```php
capture(AttendanceType::TIME_IN);
}
public function timeOut()
{
// your implementation to determine user is time out
$this->capture(AttendanceType::TIME_OUT);
}
}
```
Once created, you may want to create routes to accept Slack webhook into your app. Following is an example of route setup.
```php
Route::get('attendance/slack/time-in', function() {
$user = \App\User::whereSlackId(request()->slack_id)->firstOrFail();
(new \App\Adapters\SlackAdapter($user, now()))->timeIn();
})->name('attendance.slack.time-in');
Route::get('attendance/slack/time-out', function() {
$user = \App\User::whereSlackId(request()->slack_id)->firstOrFail();
(new \App\Adapters\SlackAdapter($user, now()))->timeOut();
})->name('attendance.slack.time-out');
```
## Test
Run the following command:
```
$ vendor/bin/phpunit --testdox --verbose
```
## Contributing
Thank you for considering contributing to the `cleaniquecoders/attendance`!
### Bug Reports
To encourage active collaboration, it is strongly encourages pull requests, not just bug reports. "Bug reports" may also be sent in the form of a pull request containing a failing test.
However, if you file a bug report, your issue should contain a title and a clear description of the issue. You should also include as much relevant information as possible and a code sample that demonstrates the issue. The goal of a bug report is to make it easy for yourself - and others - to replicate the bug and develop a fix.
Remember, bug reports are created in the hope that others with the same problem will be able to collaborate with you on solving it. Do not expect that the bug report will automatically see any activity or that others will jump to fix it. Creating a bug report serves to help yourself and others start on the path of fixing the problem.
## Coding Style
`cleaniquecoders/attendance` follows the PSR-2 coding standard and the PSR-4 autoloading standard.
You may use PHP CS Fixer in order to keep things standardised. PHP CS Fixer configuration can be found in `.php_cs`.
## License
This package is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).