kanopi / recalendar

Custom Drupal 8 module that integrates fullcalendar.js with Drupal while supporting recurring dates.
0 stars 1 forks source link

CONTENTS OF THIS FILE

INTRODUCTION

Re(curring dates) + calendar = Recalendar

The Recalendar module integrates fullcalendar.js with Drupal 8.

There are a number of Drupal 8 modules that have the same goal, but they do not support recurring dates.

REQUIREMENTS

PHP

Only works with PHP 7.1 and higher.

Core Modules

The Rest and Serialization modules in Drupal core will be enabled during installation.

Contributed Modules

The following contributed module will be automatically installed when you use composer to install

It is recommended that you install the Recurring Date Field Modular Widgets module in order to have a nice widget for the recurring date field.

Libraries

The required external javascripts are included in this module.

INSTALLATION

Composer Install

The following command installs Recalendar, its dependencies (date_recur).

composer require kanopi/recalendar

CONFIGURATION

Permissions

There is an "Allow administration of Recalendar settings" permission that can be granted to additional roles (admin role has this permission by default).

Config

By default, the calendar provided by this module is available at /recalendar. This can be changed at /admin/config/recalendar. Remember to rebuild caches after making this config change.

USAGE

  1. Enable Recalendar module
  2. Navigate to /recalendar and you will see an empty calendar
  3. You will now have a taxonomy vocabulary called "Recalendar Event Type"
  4. Add terms to the "Recalendar Event Type" taxonomy
  5. You will now have a content type called "Recalendar Event"
  6. Add and publish "Recalendar Event" nodes, tagging them with the appropriate "Recalendar Event Type" term(s)
  7. Rebuild cache
  8. Run cron
  9. Return to /recalendar - you should now see your Recalendar Events!

Note: if you want to change the /recalendar path alias and page title to something else (e.g., /calendar or /events), you can change it at /admin/config/recalendar. Remember to rebuild caches after making this config change.

MAINTAINERS

Current Maintainers

Sponsored By