TimeOff.Management Documentation

The project includes a test suite to verify main user paths. To run tests, you must have Chrome and Chrome driver installed in your path. Ensure the application is running with default settings before executing tests.

To run tests in the background, use USE_CHROME=1 npm test. If you want to visually observe the browser executing the interactions, prefix the command with SHOW_CHROME=1.

By default, the application uses its primary database (the Sessions table) to store session data. You can switch this storage mechanism to Redis to improve performance or offload session management.

To enable Redis session storage, you must ensure the application version is at least 1.4.0 and update the config/app.json file.

// Example configuration in config/app.json
{
  "sessionStore": {
    "useRedis": true,
    "redisConnectionConfiguration": {
      "host": "your-redis-host",
      "port": 6379
    }
  }
}

If you are running an existing instance and need to patch it with a new version from the master branch, use the following sequence to fetch updates, install new dependencies, and migrate the database:

1. Fetch and pull the latest code.
2. Install dependencies.
3. Run the database update script.
4. Restart the application.

git fetch
git pull origin master
npm install
npm run-script db-update
npm start

To change the colors of the existing predefined options in the leave type color picker, follow these steps:

1. Open scss/main.scss.
2. Locate the classes named leave_type_color_1 (or similar numeric suffixes).
3. Update the background property within these classes to your desired color.
4. Compile the changes by running the following command:

   npm run compile-sass

5. Commit your changes to git.

If the existing color set is insufficient, you can add new color options by modifying both the template and the styles:

1. Update the Template: Open views/partials/options_for_color_picker.hbs and add a new list item using the following format, where X is the next available integer (e.g., if leave_type_color_5 is the highest, use 6):

   <li><a href="#" class="btn btd-default leave_type_color_X" data-tom-color-picker-css-class="leave_type_color_X">Color X</a></li>

2. Update the Styles: Open scss/main.scss and define the new class leave_type_color_X with your chosen color.
3. Compile: Run the following command to generate the CSS file:

   npm run compile-sass

4. Commit: Save your changes to git.

To host the application on your own infrastructure, ensure you have Node.js (>=4.0.0) and SQLite installed. Follow these steps to clone, install dependencies, and start the server:

1. Clone the repository.
2. Navigate to the directory.
3. Install npm packages.
4. Start the application.

Once started, the application is accessible at http://localhost:3000/.

git clone https://github.com/timeoff-management/application.git timeoff-management
cd timeoff-management
npm install
npm start

To switch from database-backed sessions to Redis, follow these steps:

1. Stop the application.
2. Edit config/app.json.
3. Enable Redis: Set sessionStore.useRedis to true.
4. Configure Connection: In the sessionStore.redisConnectionConfiguration object, update the host and port keys to point to your Redis instance.
5. Restart the application.

The system supports two modes of local authentication via LocalStrategy:

1. LDAP Authentication: If the user's company has ldap_auth_enabled set to true, the system attempts to authenticate the user against the configured LDAP server.
2. Standard Password Authentication: If LDAP is not enabled, the system validates the password using the user object's is_my_password(password) method.

Upon successful authentication, the user is automatically activated via user.maybe_activate() and their session details are reloaded.

To ensure that employee names and other content are sorted according to a specific alphabet (e.g., for non-English names), configure the locale_code_for_sorting entry in the application configuration file.

• Default value: en (English)
• Supported locales: cs, fr, de, etc.