Fully-featured calendar plugin for NodeBB
JavaScript Smarty CSS
Latest commit 48c9a7e Jan 16, 2017 @pitaj 1.0.0-alpha.23

readme.md

nodebb-plugin-calendar

This plugin adds a site-wide calendar to NodeBB.

Installation

Current alpha/beta version can be installed by doing the following:

  1. Open a terminal in the NodeBB root directory
  2. Install the latest nodebb-plugin-calendar: npm install nodebb-plugin-calendar@latest
  3. Restart nodebb and activate the plugin

Configuration

Before do anything with the Calendar, make sure you have the correct settings set up in the ACP plugin settings page. Also, configure permissions for who can post events in the category management section of the ACP.

Features

  • Events created, edited, and deleted as part of a post
  • Native NodeBB category permissions are used to determine who can post and view events
  • Public events as part of the same permissions system
  • Response system for easy user responses (yes, maybe, no)
  • Configurable automated reminders for upcoming events using NodeBB's notifications system
  • Centralized calendar interface to view all upcoming events

How event creation works

  • Open the composer for creating a new topic or replying to a post. If you have permissions to post an event, you'll see a calendar icon in the toolbar. Click it to add an event to the post or edit an existing event.
  • Enter an Event name, this will show up on the calendar and on the previews.
  • All day defines if the event has a particular time or if you only want to be specific to the day.
  • Enter the start and end Dates. The end date must be after the start date.
  • The Location is parsed like a post, but can only be one line.
  • Put details in the Description field, which is also parsed like a post.
  • Add Reminders determine when subscribers get notifications about the event.
  • Mandatory events disable responses and send all reminders to any user that can view the event.

In The Works

  • iCal export
  • Simplistic, graceful calendar UI (infinite scroll) with mobile support

Suggestions? Encountered a Bug?

Please submit all feature requests and bugs with the Issue tracker at Github. Thanks!