https://github.com/bnadlerjr/hoboken

Sinatra project generator and templates.
https://github.com/bnadlerjr/hoboken

project-templates ruby sinatra

Last synced: 6 months ago
JSON representation

Sinatra project generator and templates.

• Host: GitHub
• URL: https://github.com/bnadlerjr/hoboken
• Owner: bnadlerjr
• License: mit
• Created: 2013-11-12T02:16:06.000Z (almost 12 years ago)
• Default Branch: main
• Last Pushed: 2023-10-25T21:52:55.000Z (almost 2 years ago)
• Last Synced: 2025-03-24T10:45:50.804Z (7 months ago)
• Topics: project-templates, ruby, sinatra
• Language: Ruby
• Homepage:
• Size: 1.94 MB
• Stars: 83
• Watchers: 1
• Forks: 5
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Hoboken

[![Gem Version](https://badge.fury.io/rb/hoboken.png)](http://badge.fury.io/rb/hoboken)

![Build Status](https://github.com/bnadlerjr/hoboken/actions/workflows/ruby.yml/badge.svg)

[![Maintainability](https://api.codeclimate.com/v1/badges/75e09f25ee70d6858519/maintainability)](https://codeclimate.com/github/bnadlerjr/hoboken/maintainability)

Sinatra project generator and templates.

## Installation

    $ gem install hoboken

## Usage

To see a list of available commands:

    $ hoboken

Generating a new project:

    $ hoboken generate [APP_NAME] [OPTIONS]

To see a list of options for the generate command:

    $ hoboken help generate

    Usage:

      hoboken generate [APP_NAME]

    Options:

      [--ruby-version=RUBY_VERSION]      # Ruby version for Gemfile

      [--tiny], [--no-tiny]              # Generate views inline; do not create /public folder

      [--type=TYPE]                      # Architecture type (classic or modular)

                                         # Default: classic

      [--git], [--no-git]                # Create a Git repository and make initial commit

      [--api-only], [--no-api-only]      # API only, no views, public folder, etc.

      [--test-framework=TEST_FRAMEWORK]  # Testing framework; can be either test-unit or rspec

                                         # Default: test-unit

    Generate a new Sinatra app

### Additional Generators

Additional generators are available for existing projects generated using Hoboken:

    $ hoboken add:github_action    # Github action that runs CI task

    $ hoboken add:heroku           # Heroku deployment support

    $ hoboken add:i18n             # Internationalization support using sinatra-r18n

    $ hoboken add:metrics          # Add metrics (flog, flay, simplecov)

    $ hoboken add:omniauth         # OmniAuth authentication (allows you to select a provider)

    $ hoboken add:rubocop          # Basic Rubocop configuration and Rake task.

    $ hoboken add:sequel           # Database access via Sequel gem

    $ hoboken add:sidekiq          # Background processing with the Sidekiq gem

    $ hoboken add:travis           # Basic Travis-CI YAML config

    $ hoboken add:turnip           # Gherkin extension for RSpec

    $ hoboken add:twbs             # Twitter Bootstrap (requires Sprockets add-on)

    $ hoboken add:vcr              # Record HTTP interactions and replay them during test runs

## Resources

* [Website](https://bobnadler.com/hoboken/)

* [Source Code](https://github.com/bnadlerjr/hoboken)

* [Bug Tracking](https://github.com/bnadlerjr/hoboken/issues)

* [Discussion Forum](https://github.com/bnadlerjr/hoboken/discussions)

* [Contribution Guidelines](https://github.com/bnadlerjr/hoboken/blob/main/CONTRIBUTING.md)