Skip to content
forked from gitevents/core

GitEvents core; manage your user group with GitHub

License

Notifications You must be signed in to change notification settings

JodiWarren/core

 
 

Repository files navigation

Gitter Stories in Ready

GitEvents

You're organising (or starting to organise) a user-group (be it JavaScript or anything else). Having trouble managing your time with all the tools and event apps out there?

GitEvents is a node.js service which listens to your GitHub issues and triggers various events when new issues are labeled. You can create events on meetup.com, lanyrd.com, whatever.com; announce events via email newsletters, twitter; show upcoming events and talks on your user group website and much more, completely automated and all from one place: GitHub Issues.

Implemented so far:

  • GitEvents Core
  • GitHub webhook adapter
  • Meetup.com plugin to create and update meetups.

Coming soon

  • Twitter updates
  • Mailchimp Newsletters

Requirements

  1. A GitHub Repository for your event or usergroup (example: BarcelonaJS)
  2. Issues enabled on that repository (you can activate Issues in the repository settings)
  3. From the settings in Webhooks & Services create a webhook to your service ip (example: http://barcelonajs.org/github/delivery). /github/delivery is the required path.

Setup

  1. Go to https://github.com/settings/tokens and create a token for your GitEvents application
  2. Create common/github.credentials.js with the contents:
    module.exports = {
      user: '[repo username]',
      repo: '[the repo you want to write to]',
      token: '[your token]'
    }
  1. For meetup, create common/meetup.credentials.js with the contents:
module.exports = {
  token: '[your api token]',
  group: '[your group]',
  group_id: [your group id],
  duration: 7200000, // default duration: 2h
  default_venue: 12260922 // default venue: Mobile World Centre, Barcelona
};
  1. Run the service on your trusted node.js platform

How to run gitevents?

You can start the service with:

npm run live

Start the development server:

npm run dev

Run the tests:

npm run test

Contribute

git clone https://github.com/GitEvents/core.git
npm install
cd node_modules
rm -rf gitevents-*
git clone https://github.com/GitEvents/gitevents-webhook
git clone https://github.com/GitEvents/gitevents-meetup
npm run test

Backlog / Milestone

  • Stabilise core functionality and github issue handling
  • Test and fix meetup.com event creation and updates
  • Tests for various use-cases: updating events, talks, proposals etc.

Contact

You can always get in touch in our community chat on Gitter.

Want to help?

Talk to PatrickHeneise from BarcelonaJS or IanCrowther from LNUG if you need any help. We can set up pair programming sessions for node.js beginners or for specific solutions (f.e. tests).

About

GitEvents core; manage your user group with GitHub

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 75.9%
  • Shell 24.1%