Skip to content

README.md

Latest commit

 

History

History
103 lines (69 loc) · 1.64 KB

README.md

File metadata and controls

103 lines (69 loc) · 1.64 KB

Grape Bootstrap

Introduction

Bootstrap Grape application for REST APIs. Refer to Wiki to know more about how features are implemented

Features

Dependencies

  • Ruby 2.6.2
  • PostgreSQL
  • Redis 5

Installation

  • Clone poject

  • Run bundler:

$ bundle install
  • Create database and run migrations:
$ bundle exec rake db:create db:migrate
  • Run application:
$ rackup -p 3000
  • For development:
$ bundle exec guard

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

Background Jobs

To run Cron Jobs:

$ bin/sidekiq

To run RabbitMQ Workers:

$ bin/sneakers

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

License

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