Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adrienpoly/rubyvideo
Indexing all Ruby related videos
https://github.com/adrienpoly/rubyvideo
hacktoberfest rails ruby video view-transitions-api
Last synced: about 1 hour ago
JSON representation
Indexing all Ruby related videos
- Host: GitHub
- URL: https://github.com/adrienpoly/rubyvideo
- Owner: adrienpoly
- Created: 2023-06-16T10:53:34.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-19T07:26:30.000Z (3 days ago)
- Last Synced: 2024-12-19T08:25:06.055Z (3 days ago)
- Topics: hacktoberfest, rails, ruby, video, view-transitions-api
- Language: Ruby
- Homepage: https://rubyvideo.dev
- Size: 64.9 MB
- Stars: 320
- Watchers: 4
- Forks: 55
- Open Issues: 56
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
Awesome Lists containing this project
README
# RubyVideo.dev
[RubyVideo.dev](https://www.rubyvideo.dev), inspired by [pyvideo.org](https://pyvideo.org/), is designed to index all Ruby-related videos from conferences and meetups worldwide. At the time of writing, the project has about 4000 videos indexed from 175+ conferences and 2500+ speakers.
Technically the project is built using the latest [Ruby](https://www.ruby-lang.org/) and [Rails](https://rubyonrails.org/) goodies such as [Hotwire](https://hotwired.dev/), [Solid Queue](https://github.com/rails/solid_queue), [Solid Cache](https://github.com/rails/solid_cache).
For the front end part we use [Vite](https://vite.dev/), [Tailwind](https://tailwindcss.com/) with [daisyUI](https://daisyUI.com/) components and [Stimulus](https://stimulus.hotwire.dev/).
It is deployed on an [Hetzner](https://hetzner.cloud/?ref=gyPLk7XJthjg) VPS with [Kamal](https://kamal-deploy.org/) using [SQLite](https://www.sqlite.org/) as the main database.
For compatible browsers it tries to demonstrate some of the possibilities of [Page View Transition API](https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API).
## Contributing
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 RubyVideo.dev](https://www.rubyvideo.dev/contributions) and feel free to start working on any of the remaining TODOs. Any help is greatly appreciated.
For more information on contributing conference data, please visit [this page](/docs/contributing.md).
## Getting Started
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.
### Requirements
- Ruby 3.3.6
- Docker and docker-compose (for Meilisearch)
- Node.js 20.11.0
- Meilisearch 1.1
### Setup
To prepare your database and seed content, run:
```
bin/setup
```
### Environment Variables
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.
### Meilisearch
[Rubyvideo.dev](https://www.rubyvideo.dev) search uses Meilisearch as a search engine.
To start the app, you need to have a Meilisearch service started. There is a Docker Compose available
In a new terminal :
```
docker-compose up
```
Troubleshooting:
- if no search results are returned, most probably the index is empty. You can reindex by running `Talk.reindex!` in the Rails console.
- if they are no talks at all you need to run rails db:seed first
### Starting the Application
The following command will start Rails, SolidQueue and Vite (for CSS and JS).
```
bin/dev
```
## Linter
The CI performs these checks:
- erblint
- standardrb
- standard (js)
- prettier (yaml)
Before committing your code you can run `bin/lint` to detect and potentially autocorrect lint errors.
To follow Tailwind CSS's recommended order of classes, you can use [Prettier](https://prettier.io/) along with the [prettier-plugin-tailwindcss](https://github.com/tailwindlabs/prettier-plugin-tailwindcss), both of which are included as devDependencies. This formating is not yet enforced by the CI.
## Code of Conduct
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 the [Code of Conduct](/CODE_OF_CONDUCT.md) document.
## Credits
Thank you [Appsignal](https://appsignal.com/r/eeab047472) for providing the APM tool that helps us monitor the application.
## License
Rubyvideo.dev is open source and available under the MIT License. For more information, please see the [License](/LICENSE.md) file.