Event Organizer Handbook

A practical guide for organizing tech meetups and community events, built from thoughtbot's experience running RubyMX, a Ruby meetup in Guadalajara, Mexico.

Live site: https://thoughtbot.github.io/event_organizer_handbook

Table of Contents

• Prerequisites
• Install
• Development
• Commands
• Deployment
• Contributing
• License
• About thoughtbot

Prerequisites

• GCC
• Make
• Ruby
  • >= 3.1
• Bridgetown Gem
  • gem install bridgetown -N
• Node
  • >= 20

Install

cd event-organizer-handbook
bundle install && npm install

Learn more: Bridgetown Getting Started Documentation.

Development

To start your site in development mode, run bin/bridgetown start and navigate to localhost:4000!

Commands

# running locally
bin/bridgetown start

# load the site up within a Ruby console (IRB)
bin/bridgetown console

Learn more: Bridgetown CLI Documentation

Deployment

The site deploys automatically to GitHub Pages on every push to main via the .github/workflows/gh-pages.yml workflow. No manual deployment is needed.

Contributing

We welcome contributions! This handbook is open source, but content changes should align with the editorial guidelines and maintainers have final say over what is merged.

1. Fork it
2. Clone the fork using git clone to your local development machine.
3. Create your feature branch (git checkout -b my-new-feature)
4. Commit your changes (git commit -am 'Add some feature')
5. Push to the branch (git push origin my-new-feature)
6. Create a new Pull Request

License

The handbook content is licensed under CC BY-SA 4.0. The code in this repository is licensed under the MIT License.

Built with Bridgetown, a Ruby-powered static site generator.

About thoughtbot

This repo is maintained and funded by thoughtbot, inc. The names and logos for thoughtbot are trademarks of thoughtbot, inc.

We love open source software! See our other projects. We are available for hire.