blocknotes / grape-starter-kit

A grape starter project

Grape Starter Kit

An Grape starter project with a structure similar to Rails.

Grape (a REST-like API framework for Ruby)

Features:

• simple structure ready to use
• rake tasks
• localized routes
• GRAPE_ENV for environment
• command line tool (grape)

Usage

• Clone this project: git clone https://github.com/blocknotes/grape-starter-kit
• Edit the API Application controller and the sample Posts controller
• Example route: /api/v1/en/posts

Structure

Command line

bin/grape

Options available: console, server

Files

• app
  • controllers
    • v1
      • application_controller.rb: mount point for API V1
      • posts_controller.rb: sample posts API methods
    • application_controller.rb: mount point for API
  • models
    • v1
      • post.rb: sample post model
• bin
  • grape: grape command line tool
• config
  • initializers: components configurations
  • locales: locales files
  • application.rb, boot.rb. environment.rb: startup files
  • puma.rb: puma configuration
  • routes.rb: routes configuration
• lib
  • tasks: rake tasks
• config.ru

Optional components

Cors (default: enabled)

• To disable: remove rack-cors from Gemfile and the CORS lines in config.ru

Reload (default: enabled)

• Note: with Rack::Reloader not all changes are applied after a reload
• To disable: remove Rack::Reloader line in config.ru