Git Product home page Git Product logo

whenever-web's Introduction

Whenever Web

Whenever Web is a Rails engine, that can be easily integrated with your admin panel layout.

Whenever Web

Installation

Add this line to your application's Gemfile:

gem 'whenever-web'

And then execute:

$ bundle

Usage

  1. Mount the engine in your routes.rb:
MyApp::Application.routes.draw do
  # ...
  mount Whenever::Web, at: '/whenever'
  # ...
end
  1. Go to localhost:3000/whenever.

  2. Add a link to the panel in your views:

= link_to 'Cron Jobs', whenever_path

Authentication

Out of the box Whenever::Web doesn't make any assumptions about authentication. It's possible to take advantage of rails routing constraints or rack middleware.

An example using Rack::Auth::Basic.

# config/routes.rb
Whenever::Web.middleware.use Rack::Auth::Basic do |username, password|
  username == ENV['USERNAME'] && password == ENV['PASSWORD']
end

Optional usage

Describe your Cron jobs in schedule.rb by using desc method:

require 'whenever/web'

every 1.day, at: '3:00 am' do
  desc 'Database Backup'
  rake 'db:backup'
end

Custom configuration

Put this into config/initializers/whenever_web.rb:

# Specify your own controller base eg. 'Admin::AdminController'
# Whenever::Web.config.parent_controller = 'Whenever::WebController'

# Change default schedule file path
# Whenever::Web.config.schedule_file = 'config/schedule.rb'

Contributing

  1. Fork it (http://github.com/bartoszkopinski/whenever-web/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

whenever-web's People

Contributors

bartoszkopinski avatar navinspm avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.