CLI Tool

[darcyclarke]

This is a quick draft of a CLI tool we should create, to help us more efficiently run events.

The Goal:

'start with consolidation of basic event tasks'.then('add fun features for attendees')

References:

• Event Task Overview
• Social Media Overview
• Slack Node Package
• Tito API, Package & Hooks
• Mailchimp Package
• Twitter Package

  Features:

• store access/credentials privately
• event creation
  • tito event creation
  • github "role call" issue creation
  • website update
  • slack announcement in mentor channel
  • delegates are requested for the event: space, food & drinks
• notifications
  • use templates for each to standardized event announcement messaging
  • slack announcement + channel topic change
  • email announcement (resolve email addresses acquired through mailchimp & tito)
  • twitter announcement

    API

    Mentors

• $ nsto acronym for the namespace/npm package
• $ nsto create december
  • Defaults to generating event based on the 3rd Saturday of that month, of the current year
  • --date=29 sets a specific date for the event
  • --name='Christmas Blowout!' sets a specific name for the event
  • --max=100 sets the maximum attendees for the event
• $ nsto update ...
• $ nsto notify

  Attendees

• $ nsto register april --email=<email@domain.com>

  Implementation Details

• We could try to grab the global git user info if --email isn't passed for registration
• Can't modify an event outside of the current year
  • This is for sanity and api simplicity
  • ex. $ nsto update june --name='Summer Time, Fun Times' modifies the event in June 2016

    Future Ideas

• We could add in event listing/information from this cli
  • ex. $ nsto events would return a list of the previous and upcoming events to query further

[vladikoff]

my quick thoughts:

• the api needs to know the 'location', NODE_SCHOOL_LOCATION=toronto ?
• all actions need to ask for confirmation before submitting

I think the first step would be to identify the current grunt work that is required when creating / updating events and write some hardcoded scripts that help with that (do we already have that?). Later on that can be converted into a CLI.