Platter

Platter is the evolution of railsAppCustomGenerator with the intention to create rails app with the basic setup we use at @icalialabs. It was created by Abraham Kuri from Icalia Labs.*

Platter needs ruby 2.2.1 in order to run

Installation
Usage
What it actually do?
Bug tracker & feature request
Contributing
Community
Heroes
License

Quick start

To install the gem you can just run the following command:

% gem install platter

You now have access to the platter command through the CLI.

Usage

To create a rails app the Icalia way, just use the platter command:

% platter anIcaliaWayRailsApp

This will create a rails app with the bare bones to start building an app at Icalia

Options for platter

Option Name	Description	Alias	Default
--database	Configure for selected database. PostgreSQL by default.	-d	postgresql
--skip_test_unit	Skip Test::Unit files	-T	true
--skip_turbo_links	Skips the turbolinks gem	-	true
--api	Adds API support gems and directory bare bones	-	true
--skip_bundle	Don't run bundle install	-B	true

Api

% platter anIcaliaWayRailsApp --api

What it actually do?

Platter comes with a lot of goodies.

The Gemfile looks like:

source "https://rubygems.org"

ruby "2.2.1"

gem "rails", "4.2.1"
gem "delayed_job_active_record"
gem "jquery-rails"
gem "pg"
gem "sass-rails", "~> 5.0"
gem "coffee-rails", "~> 4.1.0"
gem "uglifier", ">= 1.3.0"
gem "puma"

group :development do
  gem "spring"
  gem "spring-commands-rspec"
  gem "web-console"
end

group :development, :test do
  gem "awesome_print"
  gem "factory_girl_rails"
  gem "pry-rails"
  gem "rspec-rails", "~> 3.1.0"
  gem "ffaker"
end

# Test gems
group :test do
  gem "database_cleaner"
  gem "shoulda-matchers"
end

# Production and staging gems
group :production, :staging do
  gem "rails_12factor"
  gem "exception_notification"
end

It will also:

Setup the testing environment with Rspec, FactoryGirl, DatabaseCleaner.
Setup an staging environment to deploy to this environment
Provides the necessary configuration for the PUMA server run with Foreman
A setup script for new developers
Adds configuration for ActiveJob and DelayedJob
In case of an API, it will add Versionist and ActiveModelSerializers, along with a version 1 structure.
Adds configuration for ActionMailer to run with Sendgrid
Setup the project with git providing an initial commit

Bug tracker & feature request

For bugs and feature request, head to the issues section and if necessary create one.

Contributing

Please submit all pull requests against a separate branch. Please follow the standard for naming the variables, mixins, etc.

In case you are wondering what to attack, we hnow have a milestone with the version to work, some fixes and refactors. Feel free to start one.

Also remember to respect the Code of Conduct for open source projects.

Thanks!

Community

Keep track of new feautres, development issues and community news.

Have a question about anything, email us at [email protected]

Heroes

Abraham Kuri