Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bizley/timeclock
Simple work time clocking service
https://github.com/bizley/timeclock
clock hacktoberfest holidays register timeclock work yii
Last synced: 3 months ago
JSON representation
Simple work time clocking service
- Host: GitHub
- URL: https://github.com/bizley/timeclock
- Owner: bizley
- License: mit
- Created: 2018-12-18T14:05:24.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-25T07:08:41.000Z (9 months ago)
- Last Synced: 2024-05-01T23:25:14.116Z (9 months ago)
- Topics: clock, hacktoberfest, holidays, register, timeclock, work, yii
- Language: PHP
- Homepage:
- Size: 423 KB
- Stars: 29
- Watchers: 3
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# TimeClock
[](https://packagist.org/packages/bizley/timeclock)
[](https://www.yiiframework.com/)
Simple work time clocking service built on [Yii 2 framework](https://www.yiiframework.com).
## Installation
1. Install TimeClock using Composer:
`composer create-project --prefer-dist bizley/timeclock timeclock`
2. Prepare virtual host pointing to `/public` directory.
3. Prepare configuration for DB of your choice. Place it in `/src/config/db.php`.
4. Modify the `/src/config/web.php` file to change:
- `timeZone` (default `UTC`),
- `language` (default `en-US`; `pl` and `de` translations are provided in `/src/messages/` folder),
- `components > mailer` configuration to actually send emails (needed for password reset),
- `components > formatter` configuration of date and time formats,
- `params > company` (default `Company Name`; displayed in footer and other layout places),
- `params > email` (default `[email protected]`; used as the email sender address for emails),
- `params > allowedDomains` (default `['@company.com']`; array with email domains allowed for registration).
5. Change `/public/index.php` file to set `YII_DEBUG` mode to `false` and `YII_ENV` environment to `prod`.
6. Apply migrations by running in console `php yii migrate`.
7. Start webserver and register first account.
8. If you want to make an account to be admin run in console `php yii admin/set ID` where `ID` is DB identifier of account
to be set (usually first one is `1`).
## Ground rules
- Registering account requires its email address to be in one of the provided domains. If you want to change this behavior
you must prepare your own code. Current implementation is at `/src/models/RegisterForm.php` and `/src/views/site/register.php`.
- Session can be started at any time but it must be ended not overlapping any other ended session.
- There can be many sessions in one day.
- Session can not be longer than midnight.
- Not ended sessions not count for work hours.
- Off-time must not overlap any other off-time period.
- Holidays are automatically fetched from `https://www.kalendarzswiat.pl` which is Polish holiday list. If you want to
use something different you must prepare your own code for this. Current implementation is at `/src/models/Holiday.php`.
## Features
- account registration
- password reset
- profile update
- themes
- signing in with login or PIN
- session time with note
- off-time with note
- session and off-time history
- calendar
- holidays
- admin section
- REST API
- Bootstrap 4 layout
## New in 2.3.0
- vacations requests
- projects
- sessions time CSV download for admins
- deactivating accounts for admins
## Upgrading from 2.2.1 to 2.3.0
1. Update all the project files to match the repository.
2. Apply migrations by running in console `php yii migrate`.
## General help
Read [TimeClock Wiki](https://github.com/bizley/timeclock/wiki) first.
For anything related to Yii go to the [Yii 2 Guide](https://www.yiiframework.com/doc/guide/2.0/en).
I really don't want to point obvious links with solutions from there.
## Usage of this project
You can use this project in whatever way you like as long as you mention where did you get it from.
## Screenshots
