Skip to content

Latest commit

 

History

History
103 lines (85 loc) · 3.17 KB

README.md

File metadata and controls

103 lines (85 loc) · 3.17 KB
Raw

Check in/out for attendance on hr.my

If you are like me and hate/forget to check in/out for your attendance, and if you are using hr.my, then this is for you. A tool the automates check in/out for attendance on hr.my

Installation

Clone...configure...install dependencies...start:

git clone https://github.com/aldemeery/checker.git
cd checker
composer install
composer start

Configuration

Once the application is cloned, before starting it, go and configure your data in config.php

Email and Password

    // ...
    'email' => '[email protected]', // Your email.
    'password' => 'password', // Your password.

Check in/out times

    // ...
    'check-in' => '8:00 am', // Time you are supposed to check-in at
    'check-out' => '4:30 pm', // Time you are supposed to check-out at

And you have two approaches for checking out:

'check-out' => '4:00 pm' // Will check-out at 4:00 pm, no matter what..

Or

'check-out' => '+9 hours' // Will check-out after 8 hours have passed since you checked-in

NOTE: Values for check-in and check-out can be any supported date and time formats in PHP.

Timezone

Be sure to provide a timezone...

// ...
'timezone' => 'Africa/Cairo',

Here's a list of the supported timezones

Holidays

You can add weekend days and holidays as well... In these days you don't ckeck in/out

    // ...
    'holidays' => [
        'friday',
        'saturday',
        '2020-08-02' // dates must be in Y-m-d format
    ]

Attendance mode

Normally an employee does not show up every day at the exact same moment...(unless he/she is a psycho or something), that's why you have three attendance modes to choose from:

  • psycho You check in and out every day at the exact same second.
  • normal Gives you 1 to 15 minutes tolerance, so you check in or out every day a bit randomly, but never later than 15 minutes.
  • assholeFor those how sleep untill half of the day is gone, gives you 1 to 4 hours tolerance, so you will never be less than hour late.
    // psycho (+0 seconds)
    // normal (+1 to +15 minutes)
    // asshole (+1 to +4 hours)
    'mode' => 'normal',

Notifications

You can recieve slack notifications about next check in/out time, and when a check in/out is performed.

To do so, you only need to create an incoming webhook on your slack account, then take the webhook URL and add it in the config file.

    'slack' => [
        'hook' => "https://hooks.slack.com/services/...",
        'settings' => [
            // ...
        ],
    ],

License

The MIT License (MIT). Please see License File for more information.