Bluebase API

The base app for Blueprint's Rails API apps.

Features

Core gems:

Thin for the server
Postgres to use postgres as the database
Figaro for environment variables

Component gems:

Devise for user auth
Gon to push data to javascript
Kaminari for pagination
Recipient Interceptor to stop email sending from staging

Development gems:

Annotate to annotate models
FFaker to generate random data
Better Errors + Binding of Caller for useful error pages
Quiet Assets to quiet asset rending output in the server
Spring for fast commands
Rubocop for Rails linting
I18n Tasks to lint translation files
Awesome Print for better console object printing
Guard to run tasks on file changes
Pry and Pry Byebug to explore objects and debug

Test gems:

RSpec for specs
Capybara for integration tests
FactoryGirl for test data
Shoulda Matchers for common RSpec matchers
Launchy to use save_and_open_page in Capybara
Database Cleaner to clear the database for specs
CodeClimate Test Reporter to track test coverage

Production gems/features (most of these require setup):

New Relic for monitoring performance
Rollbar for error logging
Rails 12Factor for Heroku

Other features:

Staging environment config
Email config using SMTP
The ./bin/setup convention for new developer setup
Rails' flashes set up and in application layout
Configuration for Rubocop/Hound
A Guardfile set up with Livereload, RSpec, and Rubocop
A few nice time formats set up for localization
Rack::Deflater to compress responses with Gzip
A low database connection pool limit
t() and l() in specs without prefixing with I18n
An automatically-created SECRET_KEY_BASE environment variable in all environments.
Config for Google Analytics
Removed assets and views pipeline
Set up api folder structure with base controller
Set up api routes to receive and return JSON

Installation

Run

gem install bluebase_api

Then you can run

bluebase_api app_name

To create an app called app_name. Optionally append -G repo_name and -H to create a Github repo and staging + production Heroku apps, respectively.

Contributing

Feel free to open issues or send pull requests with improvements. Thanks in advance for your help!

Cal Blueprint

Cal Blueprint is a student-run UC Berkeley organization devoted to matching the skills of its members to our desire to see social good enacted in our community. Each semester, teams of 4-5 students work closely with a non-profit to bring technological solutions to the problems they face every day.

Credits

Bluebase_api is a fork of thoughtbot's suspenders

bluebase_api

Development