Skip to content

Latest commit

 

History

History
126 lines (109 loc) · 6.05 KB

File metadata and controls

126 lines (109 loc) · 6.05 KB

ConTroll™ Registration for Conventions

Control Troll Logo
ConTroll™ and the ConTroll Troll Logo are Copyright 2015-2026, Michael Rafferty

This README file is current as of Release 2.0 of the ConTroll Regitration System.

ConTroll™ is designed as an all-in-one system to support registration for conventions. It supports on-line, mail-in, and on-site registration.

ConTroll™ is freely available for use under the GNU Affero General Public License, Version 3 (https://www.gnu.org/licenses/agpl-3.0.en.html). Local changes are allowed, but all changes to ConTroll™ must be freely offered to the ConTroll™ developers for potential integration into the system.

To install controll on your server, see the install directory for System Requirements and the Setup Sequence. The Setup_Sequence.md file gives you a step by step guide to installing ConTroll on your server.

ConTroll is a combination of PHP, Javascript, and custom templates. It currently requires PHP 8.3 and uses add-ons using Composer, as well as CDNs for tabulator and bootstrap. Relevant versions are found in lib/jsVersions.php.

Release Notes

Release notes can be found in the ReleaseNotes directory.

System Documentation and Coding Standards

As with all projects this is a work in progress, but the current items are in the System-Documents-and-Coding-Standards directory.

User Documentation Samples

Several sample user documents, including ones written by the ConTroll developers for use in writing documents for your specific convention can be found in the UserDoc-Samples directory. Feel free to copy those to the UserDoc directory to make your own customized versions.

Development

The system is under active development by a team of developers and has functions currently in development to support:

  • Adding reports to the rewritten report subsystem
  • Rewrite of the Registration Portal UI/UX with the learnings from the first release
    • Already completed
      • Main portal page redesign
      • Move of age to the profile
      • System wide common profile editor
      • Bundle Memberships
      • New Login and Authentication Token system for the controll back end with passkey support.

Planned future additions:

  • Configurable Exhibitor Portals (not just artist and vendor)
  • Reconfiguring the control menu structure and addition of more detailed role based permissions

Registration Tools in this Repository:

  • Composer: Add-on's to PHP tracked by Composer (composer.json and composer.lock)

  • atcon: Onsite Registration Processing and Management

    • admin: Administer on-site reg system (Users, Printers, Square Terminals)
    • artInventory: Audit and maintain art inventory in the artist spaces
    • artpos: Point of Sale (Cashier) for artwork managed by the inventory system, supports use of Square Terminal API
    • printform: Print arbitary badges
    • regpos: Point of Sale (Check-in and Cashier), supports use of Square Terminal API
    • volRollover: Volunteer Rollover for sufficient hours worked
  • controll: Registration Administration, control, and reports

    • Current:
      • Administration
        • ConTroll Users and Roles
        • Main Menu Tab Ordering
        • Atcon Users and Roles
        • Atcon Printer Setup
        • Configuration Editor (full reg_conf.ini contents)
      • Membership Graphs
      • People - manage information about people in the database
        • Resolve Conflicts
        • Add New Person
        • Edit Existing Person
      • Mail-in/Manual Registration
      • Complimentary Registration (Free Badges)
      • Registration Lookup
        • Limited Read Only Access
      • Registraion Administration
        • Registration List/Transfer/Rollover/Edit
        • Membership Setup: Membership Items/Prices/Availability
        • Membership Configuration
        • Custom Text (All but Exhibitor pages)
        • Policies: For people to agree to
        • Interests: For people to express interest and get referred
        • Membership Rules: Which memberships require special rules to be available for purchase
        • Merge People: Combine two people into one surviving record
        • Configuration Editor (for those with reg-admin rights)
      • Attendence Graphs
      • Finance
        • Sales Tax Configuration
        • Payment Plan Configuration
        • Payment Plan Management (Payors)
        • Coupon Management
      • Exhibits/Exhibitor Mangement
        • Exhibits Configuration
          • Types (rules)
          • Regions (areas using those rules)
          • This Years Regions (configuration for this year)
          • Spaces (sections of an area)
          • Pricing (pricing options within a space)
        • Custom Text
        • Configuration Editor (for those with exhibits rights)
        • Exhibitor Mangement (by Region Owner)
          • Exhibitor Information (Add/Edit)
          • Approval Requests (for regions that require approval to ask for space)
          • Space Requests (enter/approve/control/pay space requests)
      • Art Control (Manage/Edit art inventory)
      • Report Subsystem
        • Both ConTroll administered reports and Local report additions
        • Support for both PHP and report processor (text template) based configurable reports
        • Assigning permission rights to access specific reports
    • In controll, but still in old format (functions, but not yet updated)
      • Club Management
  • onlinereg

    • buy memberships in a single web page without login or history
    • checkReg - obsoleted by portal, but still provided for onlinereg
  • portal

    • Login page/functions (Supports mail tokens, Google/Facebook and potentially other "login with") and passkeys
    • Portal - main home page, see/pay for memberships
    • paymentHistory - shows payments for this account for this convention year.
    • add - add new accounts
    • cart - add new memberships
    • accountSettings - alternate identities (emails), passkeys, and people you manage
    • Membership History - current and prior years registrations
    • respond - back end respond to authorization requests
  • vendor (artist/dealer/exhibitor/fan tables)

    • Login page/functions
    • Apply / Request Space
    • Pay for space and memberships
    • Enter art inventory (if art show style portal)