Find actively maintained & popular open source software libraries for the Ruby programming language

The Ruby Toolbox is a catalog of all Rubygems that keeps track of popularity and health metrics to help you choose a reliable library.

This is the source code for the site you can visit at https://www.ruby-toolbox.com/

Development

💡 We provide a ready devcontainer configuration which you can use locally or on GitHub codespaces - for further details please refer to .devcontainer/README.md. This is the easiest way to get a fully functional development setup.

Prerequisites

You will need PostgreSQL as the database and Redis for background job processing — see Configuration for details and installation pointers.

Tooling via mise

Tool versions (Ruby, Node.js and pnpm) are managed with mise, which also serves as the project's task runner. After installing mise, run mise install inside your checkout to get the full toolchain.

Running the application

1. Start postgres and redis
2. Install the project's dependencies and prepare the database with mise run setup
3. Optional but recommended: Import a partial production database dump using bin/pull_database. You can also load some test data quickly by running rake db:fixtures:load
4. In order to access the GitHub GraphQL API for pulling repo data, you need to provide a GITHUB_TOKEN — see the Github API Client configuration.
5. Run the development processes (web, worker & vite) with mise run server. You can access the site at http://localhost:5000

Further steps

• You can run the test suite with mise run test
• You can check code style and security with mise run lint (and auto-format with mise run format)
• During development you can launch guard using bundle exec guard to continuously check your changes
• The repo has overcommit git hooks set up to check your changes before commit, push etc. You can set it up once with bundle exec overcommit --install. Whenever the hook config file .overcommit.yml changes, you need to verify it's contents and approve the changes with bundle exec overcommit --sign
• You can find the sidekiq web UI at http://localhost:5000/ops/sidekiq. Username can be empty, the default password is development.

Production

See our overview of Configuration settings for an overview of what needs to be set up to run the app in production, and Deployment for how the production app on fly.io is deployed and operated.

Code of Conduct

Everyone participating in this project's development, issue trackers and other channels is expected to follow our Code of Conduct

License

This project is available as open source under the terms of the MIT License.