https://github.com/dannyyu92/barebones
Personal Rails Template Generator
https://github.com/dannyyu92/barebones
barebones rails-api rails-engine rails-template rails5
Last synced: 5 months ago
JSON representation
Personal Rails Template Generator
- Host: GitHub
- URL: https://github.com/dannyyu92/barebones
- Owner: dannyyu92
- License: mit
- Created: 2015-08-14T02:58:17.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-10-19T07:21:14.000Z (over 7 years ago)
- Last Synced: 2025-01-14T11:21:11.366Z (5 months ago)
- Topics: barebones, rails-api, rails-engine, rails-template, rails5
- Language: Ruby
- Homepage:
- Size: 61.5 KB
- Stars: 45
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Barebones
===
[](https://badge.fury.io/rb/barebones)
Barebones is my personal base Rails application. After developing a
couple of Rails applications, I thought that there were some common
gems and patterns that would be nice to have out of the box.
## Installation
Install the gem:
gem install barebones
Then run:
barebones [AppName]
### Flags
If you don't like using any of the below gems or configurations for whatever reason, you can skip them:
* --skip-api
* --skip-resque
* --skip-sidekiq
* --skip-minitest
* --skip-factory-girl
* --skip-carrierwave
For example:
barebones [AppName] --skip-api --skip-minitest
## Gemfile
Barebones' [Gemfile](templates/Gemfile.erb) includes various preconfigured gems such as:
### Webserver
* [Puma](https://github.com/puma/puma) for our default concurrent webserver. Configured to spawn on free Heroku instances [out of the box](templates/puma.rb#L63).
### File Uploading
* [Carrierwave](https://github.com/carrierwaveuploader/carrierwave) for file uploading
* [Fog](https://github.com/fog/fog) for AWS/Google cloud storage
* [MiniMagick](https://github.com/minimagick/minimagick) for image cropping/resizing and all that good stuff
### Background Processing
* [Sidekiq](https://github.com/mperham/sidekiq) for background workers. This is the default option.
* [Resque](https://github.com/resque/resque) for background workers
* [Resque-Scheduler](https://github.com/resque/resque-scheduler) for queueing workers in the future
### Database
* [Postgres](https://rubygems.org/gems/pg/versions/0.18.3)
### Dev/Testing
* [Byebug](https://github.com/deivid-rodriguez/byebug) for debugging
* [Pry Byebug](https://github.com/deivid-rodriguez/pry-byebug) for debugging background jobs
* [Web Console](https://github.com/rails/web-console) for debugging views
* [Awesome Print](https://github.com/awesome-print/awesome_print) for pretty printing command line objects
### Testing
* [Minitest](https://github.com/blowmage/minitest-rails) for TDD/BDD
* [Minitest Reporters](https://github.com/kern/minitest-reporters) for customizable Minitest output formats
* [Minitest Around](https://github.com/splattael/minitest-around) for database setup/teardown
* [Mocha](https://github.com/freerange/mocha) for mocking and stubbing
* [Database Cleaner](https://github.com/DatabaseCleaner/database_cleaner) to ensure a clean state during tests
### API
* [Jbuilder](https://github.com/rails/jbuilder) for building JSON structures
* [oj](https://github.com/ohler55/oj) for faster JSON parsing (and a faster Jbuilder)
* [oj_mimic_json](https://github.com/ohler55/oj_mimic_json)
* [MultiJSON](https://github.com/intridea/multi_json)
## Design Patterns
* Services (Pre-made folder)
* [Custom Decorator Class](templates/barebones_decorator.rb.erb) (A custom subclass of SimpleDelegator)
## API
* [Routes](templates/routes.rb.erb) with API subdomain and version namespacing
* [ApiConstraints](templates/api_constraints.rb.erb) for API version control
* [Configurations/Ping endpoint](templates/configs_controller.rb) to test that the API works :)
## Dependencies
Barebones requires the latest version of Ruby (2.4.1), Rails (5.1.1), and
PostgreSQL (9.4) on your local machine.
## License
Barebones is copyright © 2015-2016 Danny Yu.
It is free software, and may be redistributed under the terms specified in the [LICENSE] file.
[LICENSE]: LICENSE