Mayo Events Manager

Description

Pronounced “my-oh”. Referring to the Spanish word “mayo” which means “May” in English. Mayo Event Manager is a comprehensive WordPress plugin designed to facilitate the management of events with a focus on community engagement and administrative oversight. This plugin allows users to submit events for approval, supports recurring event schedules, and integrates seamlessly with WordPress’s native features like featured images and custom post types. Mayo is meant to be simple, and does not provide all the functionality of a typical event management system. It is designed to be used in conjunction with a BMLT server to provide a simple way to submit events for a specific service body. Also we will not be implementing a calendar view, but rather a list view. There are plenty of other plugins that provide calendar views, and you can make use of the calendar RSS to import the feeds you want.

1. Event Submission and Approval:

   • Users can submit events through a public-facing form.
   • Submitted events are saved as pending, requiring admin approval before they are published.
   • Admins receive email notifications upon new event submissions, ensuring timely review and approval.

2. Recurring Events:

   • Supports daily, weekly, and monthly recurring event patterns.
   • Users can specify recurrence intervals and end dates.
   • Recurring events are automatically generated based on the specified pattern.

3. Event Details and Customization:

   • Events can include detailed information such as event type, start and end dates, times, and location details.
   • Supports the use of WordPress’s featured image functionality to visually represent events.
   • Allows categorization and tagging of events for better organization and filtering.

4. Service Body Integration:

   • Integrates with external service bodies, allowing users to associate events with specific service organizations.
   • Fetches and displays service body information dynamically.

5. Email Notifications:

   • Sends email notifications to the site admin when a new event is submitted.
   • Ensures that admins are promptly informed of new submissions for review.

6. REST API Integration:

   • Provides REST API endpoints for submitting events, retrieving event details, and managing settings.
   • Facilitates integration with other systems and custom front-end applications.

7. User-Friendly Interface:

   • Intuitive form interface for event submission, including validation for required fields like email.
   • Admin interface for managing events, including viewing, editing, and approving submissions.

Additional Information

Mayo WordPress Plugin

A WordPress plugin for managing and displaying events from a BMLT root server.

CSS Documentation

The plugin includes documentation for the dynamic CSS classes used in the Event Card component. This helps developers understand and customize the appearance of events on their site.

Important Note About Styling

This plugin does not include a built-in CSS editor. To style the event cards, you need to use another plugin like “Simple Custom CSS” or add CSS to your theme’s stylesheet. The documentation is provided to help you understand which CSS classes are available for styling.

Viewing the Documentation

The CSS documentation is available in the WordPress admin area under the Mayo menu. It includes:

• Dynamic classes generated based on event properties
• Examples of how to customize the appearance

Customization

You can customize the appearance of events by adding CSS rules to your theme or using a custom CSS plugin. The documentation provides examples of common customizations, such as:

• Styling specific categories or tags
• Customizing the appearance of different event types
• Adding styles for specific service bodies

Recommended CSS Plugins

• Simple Custom CSS (https://wordpress.org/plugins/simple-custom-css/)
• Custom CSS and JS (https://wordpress.org/plugins/custom-css-js/)
• Advanced Custom CSS (https://wordpress.org/plugins/advanced-custom-css/)

Development

Prerequisites

• Node.js (v14 or higher)
• npm (v6 or higher)

Installation

1. Clone the repository

2. Install dependencies:

   npm install

3. Build the plugin:

   npm run build

Development Workflow

1. Start the development server:

   npm run dev

2. Make changes to the code

3. Rebuild the plugin as needed

License

This project is licensed under the GPL v2 or later.

Technical Details

• Custom Post Type: Utilizes a custom post type mayo_event to store and manage events.
• JavaScript Components: Built with React and integrated into the WordPress admin and front-end using Gutenberg components.
• Email Handling: Uses WordPress’s wp_mail function to send notifications.
• Data Storage: Stores event metadata using WordPress’s post meta system, ensuring compatibility and scalability.