⏰ RailsCron — Distributed Cron Scheduler for Rails

First release 0.1.0 is empty gem. A scheduler-agnostic, multi-node-safe cron runner for Ruby and Rails.
Designed and maintained by Codevedas Inc.

---

🧭 Project Structure

This repository contains the RailsCron gem and its documentation site.

/repo-root
├── .github/              # CI workflows, issue templates
├── rails_cron/           # Gem source (lib/, bin/, gemspec)
├── docs/                 # Documentation site (Jekyll + Markdown)
└── README.md             # This file

---

🧩 What It Does

rails_cron lets you register, schedule, and safely run recurring tasks across multiple Rails instances.
It ensures exactly-once dispatching per cron tick using distributed locks via Redis or PostgreSQL advisory locks.

It’s scheduler-agnostic — works with any background job system (ActiveJob, Sidekiq, Resque, etc.)
and provides a clean Ruby API, CLI, and Rails tasks.

---

📚 Documentation

Comprehensive guides are published at:

👉 https://rails-cron.codevedas.com

Section	Description
Overview & Motivation	Why RailsCron exists
Installation & Setup	Gem setup and initializer
Usage	Registering jobs, CLI, and Rake tasks
FAQ / Troubleshooting	Common issues and fixes

---

🛠️ Local Development

1. Clone and setup

git clone https://github.com/CodevedasInc/rails-cron.git
cd rails-cron
bundle install

2. Run specs

bin/rspec-unit

3. Lint and format

bin/rubocop

4. Reek

bin/Reek

---

🧪 Running the Gem Locally

You can load a local version of the gem in a test Rails app:

gem build rails_cron.gemspec
gem install ./rails_cron-0.1.0.gem

Or reference it directly in another app’s Gemfile:

gem "rails_cron", path: "../rails-cron/rails_cron"

---

🚀 Docs Site (Jekyll)

The docs/ directory is a Jekyll site used for GitHub Pages.

Run locally

cd docs
bundle install
bundle exec jekyll serve

Then open: 👉 http://localhost:4000

---

⚙️ Continuous Integration

GitHub Actions workflows include:

Workflow	Purpose
ci.yml	Runs tests (RSpec + RuboCop) on all Ruby versions
release.yml	Builds and publishes gem to RubyGems
jekyll-gh-pages.yml	Builds and deploys docs to GitHub Pages

---

Contributing, Security, Conduct

• Contributing: see CONTRIBUTING.md
• Security policy: see SECURITY.md
• Code of Conduct: see CODE_OF_CONDUCT.md

---

📄 License

Released under the MIT License © 2025 Codevedas Inc. — All rights reserved.