EventEule self-updates
Event-Plugin für wordpress
by Thomas Herfort · github.com/twicemind/eventeule · website
Install
No release zip yet. The repository archive installs, but the folder name will carry the branch suffix and updates will not flow:
wp plugin install https://github.com/twicemind/eventeule/archive/refs/heads/main.zipShips its own WordPress updater (Plugin Update Checker), so new versions show up under Dashboard → Updates.
WordPress Event Plugin for Events, Appointments and Activities.
Features
- 📅 Event Management with date, time, location
- 🏷️ Event Categories
- ⭐ Featured Events
- 🎨 Elementor Integration (Dynamic Tags)
- 🎨 Customizable Widget Colors
- 📊 Admin Dashboard with Statistics and Calendar View
- 🔄 Automatic Updates via GitHub Releases
- 🌍 Multilingual (German/English)
Installation
From GitHub Release (Recommended)
- Download the latest ZIP file from Releases
- In WordPress Admin: Plugins → Add New → Upload Plugin
- Choose the ZIP file and install
- Activate the plugin
📖 Full Installation Guide: INSTALLATION.md
Automatic Updates
The plugin automatically checks GitHub Releases and displays available updates in WordPress Admin. One-click updates directly from WordPress - no configuration required.
Local Development
⚠️ Important: Please read the security notes first!
# Clone repository
git clone https://github.com/twicemind/eventeule.git
cd eventeule
# Install dependencies
composer install
npm install
# Create local configuration
cp .env.example .env
cp config-local.example.php config-local.php
# Start WordPress test environment
npm run wp:start
Import Production Data (Optional)
🎯 Recommended: All-in-One WP Migration Plugin
The easiest way to import production data into your local environment:
# 1. Install the import plugin
npm run import:setup
# 2. Export from production site
# - Install "All-in-One WP Migration" on production
# - Export to File (.wpress)
# - Download the file
# 3. Import via WordPress Admin
# - Open: http://localhost:8888/wp-admin
# - Go to: All-in-One WP Migration → Import
# - Upload your .wpress file
# - Done! ✨
📖 Full Import Guide: IMPORT_PRODUCTION_DATA.md
📖 Setup Guide: LOCAL_SETUP.md
Security
🔒 Important: This repository contains no sensitive data!
- All credentials remain local
.envand local configs are in.gitignore- GitHub tokens are only stored locally
📖 Details: SECURITY.md
Usage
Shortcode
[eventeule_events limit="5" category="workshops"]
Parameters:
limit- Number of events (default: 10)category- Filter by category slugfeatured_only- Show only featured events (true/false)show_past- Show past events (true/false)
Elementor
All event metadata is available as Dynamic Tags:
- Event Start Date (with format selection)
- Event End Date
- Event Start Time
- Event End Time
- Event Location
- Event Registration URL
- Event Note
Template Override
Copy templates/public/events-list.php to your theme:
your-theme/eventeule/events-list.php
Release Process
One-Click Release (Recommended)
npm run release
This one command handles automatically:
- ✅ Run tests
- ✅ Choose release type (interactive)
- ✅ Bump version
- ✅ Create commit
- ✅ Push to GitHub
- ✅ GitHub Actions creates release
Manual Releases
# Bump version
npm run release:patch # 1.0.0 -> 1.0.1
npm run release:minor # 1.0.0 -> 1.1.0
npm run release:major # 1.0.0 -> 2.0.0
# Push to GitHub
git push && git push --tags
GitHub Actions automatically creates a release with installable ZIP.
📖 Details:
- RELEASE_WORKFLOW.md - One-Click Release Explained
- RELEASE.md - Detailed Release Documentation
- QUICKSTART.md - First Release
Technology
- PHP: 7.4+
- WordPress: 6.0+
- Architecture: PSR-4 Autoloading, OOP
- Build: Composer, npm
- CI/CD: GitHub Actions
- Updates: Plugin Update Checker
Project Structure
eventeule/
├── src/
│ ├── Admin/ # Admin Interface
│ ├── Api/ # REST API
│ ├── Domain/ # Post Types, Taxonomies
│ ├── Frontend/ # Public Templates
│ ├── Integration/ # Elementor, etc.
│ ├── Repository/ # Data Access
│ └── Support/ # Helper Classes
├── templates/ # Template Files
├── assets/ # CSS, JS, Images
├── languages/ # Translations
├── docs/ # Documentation
└── scripts/ # Build Scripts
Contributing
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Documentation
📚 Full Documentation: docs/
Includes guides for:
- Installation and Configuration
- Local Development
- Release Process
- Security
- and more
License
ISC License - see LICENSE
Support
- 📧 Email: support@twicemind.com
- 🐛 Issues: GitHub Issues
- 📖 Docs: Wiki
Changelog
See Releases for detailed changes.
Developed with 💙 by twicemind