Repository files navigation

RubyEvents.org (formerly RubyVideo.dev), inspired bypyvideo.org, is designed to index all Ruby-related events and videos from conferences and meetups around the world. At the time of writing, the project has 6000+ videos indexed from 200+ events and 3000+ speakers.

Technically the project is built using the latestRuby andRails goodies such asHotwire,Solid Queue,Solid Cache.

For the front end part we useVite,Tailwind withdaisyUI components andStimulus.

It is deployed on anHetzner VPS withKamal usingSQLite as the main database.

For compatible browsers it tries to demonstrate some of the possibilities ofPage View Transition API.

This project is open source, and contributions are greatly appreciated. One of the most direct ways to contribute at this time is by adding more content.

We also have a page on the deployed site that has up-to-date information with the remaining known TODOs. Check out the"Getting Started: Ways to Contribute" page on RubyEvents.org and feel free to start working on any of the remaining TODOs. Any help is greatly appreciated.

For more information on contributing:

• Conference data:Contributing Guide
• Visual assets (logos, banners, etc.):Adding Visual Assets Guide
• Sponsor information:Adding Sponsors Guide

You can view all event assets and their status at:https://rubyevents.org/pages/assets

We have tried to make the setup process as simple as possible so that in a few commands you can have the project with real data running locally.

In addition to the local development flow described below, we supportdevcontainers.If you open this project in VS Code and you have thedev containers extension installed, it will prompt you and ask if you want to reopen in a dev contatiner.This will set up the dev environment for you in docker, and reopen your editor from within the context of the rails container, so you can run commands and work with the project as if it was local.All file changes will be present locally when you close the container.

• Usegh auth login to auth with GitHub, so you can push commits from within the container.
• Do not runbin/setup. It starts docker containers, and you're already in one.
• After the container is set up, runbin/dev in the terminal to start the development server. The application will be forwarded to localhost:3000.
• To run system tests, useHEADLESS=true bin/rails test. The HEADLESS=true environment variable ensures Chrome runs in headless mode, which is required in the container environment.

• Ruby 3.4.7
• Node.js 22.15.1

To prepare your database and seed content viadocker-compose, run:

# Note: this requires docker daemon running on your machine.bin/setup

You can manually seed content by running:

bin/rails db:seed

You can use the.env.sample file as a guide for the environment variables required for the project. However, there are currently no environment variables necessary for simple app exploration.

The following command will start Rails, SolidQueue and Vite (for CSS and JS).

bin/dev

The CI performs these checks:

• erblint
• standardrb
• standard (js)
• prettier (yaml)

Before committing your code you can runbin/lint to detect and potentially autocorrect lint errors.

To follow Tailwind CSS's recommended order of classes, you can usePrettier along with theprettier-plugin-tailwindcss, both of which are included as devDependencies. This formating is not yet enforced by the CI.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms. More details can be found in theCode of Conduct document.

Thank youAppsignal for providing the APM tool that helps us monitor the application.

RubyEvents.org is open source and available under the MIT License. For more information, please see theLicense file.