Create Ruby App

Build Status Gem Version

create-ruby-app is an opinionated tool for scaffolding Ruby applications effortlessly inspired by Create React App. It generates only the essentials needed to start working.

It specifically targets non-Rails applications. For Ruby on Rails apps, it might be worth looking into Rails Application Templates instead, and if you are building a gem, please take a look at the bundle gem command.

Requirements

  • Ruby (version 2.7.1 or newer).

Installation

gem install create-ruby-app

Usage

create-ruby-app new NAME [--ruby RUBY] [--gems GEMS]

Example

create-ruby-app new my-app --gems sinatra,sequel --ruby ruby-2.7.1

This will generate the following project structure with Sinatra and Sequel added to the Gemfile.

my_app
├── bin/
│   └── my_app
├── lib/
│   ├── my_app/
│   └── my_app.rb
├── spec/
│   ├── lib/
│   │   └── my_app/
│   └── spec_helper.rb
├── .ruby-version
└── Gemfile

Once the project is generated, it will run bundle install so you can start working.

License

See LICENSE.