Rails 5 API starter is a boilerplate which helps you build fast, secure and efficient API for applications. Template based on automatically generated structure of directory and settings which are default delivered by --api switch. Additional to settings are added and initially configure useful Gems, which are often used in Rails stack application.
NOTE: The template is still in the development version. Don't use in production!
- omniauth
- devise
- devise_token_auth
- jbuilder
- rspec-api-documentation
- yard
- rspec-rails
- factory-girl
- faker
- simpleconv
- rack-attacker
- rack-timeout
- readthis
- hiredis
- spirng
$ git git@github.com:Hawatel/rails5-api-starter.git
$ bundel install
$docker-compose build
$docker-compose run rails5-api-starter bin/rails db:migrate RAILS_ENV=development
$docker-compose up
| Command | Description |
|---|---|
bin/rails s -e development |
start development server on localhost:3000 |
bin/rails s -e production |
start production server on localhost:3000. |
bin/rails spec:docs |
generate API docs files. Output is saved in to docs directory. |
bin/rails dev:cache |
enable/disable cache mode |
bin/rails spec |
run spec tests |
The Starter Kit is available as open source under the terms of the MIT License.
- https://github.com/phatworx/devise_security_extension - Add Devise security extension
- Delete deprecation warnings from RSpec