Skip to content

Latest commit

 

History

History
89 lines (64 loc) · 3.27 KB

README.md

File metadata and controls

89 lines (64 loc) · 3.27 KB
Raw

RNG is a Drupal module enabling people to register for events.

Copyright (C) 2016 Daniel Phin (@dpi)

Build Status

License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

About

RNG is inspired by contributed Registration and Signup modules. Development originally began early 2013, but has been reworked due to inactivity of the original project, and unexpected extension of development timeline for Drupal 8.

See MAINTAINERS.txt for a list of official developers.

Dependencies

RNG

RNG Views sub module

Terms

  • Event: any content entity.
  • Registration type: bundle entity for Registrations.
  • Registration: an entity that associates with one Event, and has at least one child Registrant. Each Registration has at least one owner Registrant.
  • Registrant: an entity that maintains a relationship between a Registration and an Identity.
  • Identity: an entity that has implemented a method for contact. Cores' user module provides the User entity. Identity module provides the Contact entity, allowing users to create registrations by providing an email address.
  • EventType: and entity maintaining configuration, and default values for EventConfig. Each EventType is associated with another entity/bundle combination.

Model

┌─ Event Type
├─ Registration Type(s)
└─►Event ─┬─► Registration(s) ─┬─► Registrant(s) ─► Identity
          ├────────────────────┴─► Group(s)
          └─► Rule(s) ─┬─► Action(s)
                       └─► Condition(s)

A Registration is a content entity that associated with an Event entity, and maintains relationships to Identities via Registrant entities. Each Registrant maintains a relationship between a Registration and an Identity. Registrant entities are content, and thus can hold meta information in fields describing how an Identity relates to a Registration.

Usage

Please see the project websites for instructions:

Building

SASS

sass --watch sass:css --style expanded