Oliveirakun/grape-bootstrap

Basic API application using Grape with ActiveRecord, RSpec and Swagger UI

Grape Bootstrap

Introduction

Bootstrap Grape application for REST APIS with ActiveRecord, RSpec and Swagger integration

Dependencies

• Ruby 2.3.4
• MySQL

Installation

• Clone poject
• Run the script:

$ bin/setup

• Run bundler:

$ bundle install

• Create database and run migrations:

$ bundle exec rake db:create db:migrate

• Run application:

$ rackup -p 3000

Docker

To run application on docker:

• Install Docker and Docker-Compose
• Clone the project
• Run these commands on project root:

$ docker-compose build
$ docker-compose up

# Open another terminal and run:
$ docker-compose run web bundle exec rake db:create db:migrate

Console

To use console, run the following command:

$ bin/console

Tests

To execute tests, run the following command:

$ bundle exec rspec

Routes

To show the application routes, run the following command:

$ bundle exec rake routes

Swagger Documentation

To access swagger documentation, enter the root application address in the browser:

http://localhost:3000

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Oliveirakun/grape-bootstrap.

License

The software is available as open source under the terms of the MIT License.