Overview

The Visitor Badge is a theme that allows users to create and customize visitor badges for events or organizations. It provides an easy-to-use interface for managing visitor information and generating badges. The theme can be customized through a configuration file and supports integration with Redis and Memcached for improved performance.

Features

• Easy installation and setup
• Customizable configuration file
• Support for Redis and Memcached integration
• Ability to add multiple servers for scalability
• Compatible with PHP 7.4 or higher
• Support for Redis server version 3.0.0 or higher
• Support for Memcached server version 1.4.31 or higher
• Customizable dashboards
• Includes testing with PHPUnit and PHPStan
• Supports Tailwind CSS compilation

Installation

To install the Visitor Badge theme, follow these steps:

1. Extract the content of the theme.
2. If using the default settings, the theme should work out of the box.
3. To customize the configuration file, copy config.dist.php into config.php and make your changes there.
4. It is highly recommended to run composer install before using the theme.
5. To update the theme, replace all files and delete the tmp folder (which contains only compiled Twig templates).
6. If using Docker, you can find the container at https://hub.docker.com/r/robinn/phpcacheadmin. Use the provided command or include it in your docker-compose.yml file.
7. For Redis integration, set the required environment variables. These include the server name, host, port, scheme, SSL options, database, username, password, authentication file, path, number of databases, and scan size.
8. For Memcached integration, set the required environment variables. These include the server name, host, port, and path.
9. To add another server, add the same environment variables but change the index number in the variable names.
10. Ensure that the following requirements are met: PHP version 7.4 or higher, Redis, Memcached, Opcache or APCu PHP extensions, and Redis server version 3.0.0 or higher.
11. If the Redis extension is not installed, the theme will use a Predis client. Install Predis manually via composer require predis/predis if using Composer.
12. If the Memcache(d) extension is not installed, the theme will use a custom PHPMem client.
13. For better performance, always use the recommended extensions.
14. To compile Tailwind CSS, run npm install and then either npm run build or npm run watch for auto-compiling.

Summary

The Visitor Badge theme is a versatile and customizable solution for managing visitor badges. With easy installation, support for Redis and Memcached integration, and compatibility with PHP 7.4 or higher, it offers a user-friendly interface for creating and managing badges. Additionally, the theme includes features such as customizable dashboards, testing with PHPUnit and PHPStan, and support for Tailwind CSS compilation. Overall, the Visitor Badge theme provides a comprehensive solution for managing visitor badges in an efficient and customizable way.