Skip to content

Latest commit

 

History

History
47 lines (27 loc) · 690 Bytes

README.md

File metadata and controls

47 lines (27 loc) · 690 Bytes
Raw

README

A thin restful API mounted on Rails 5 using Grape, MongoDB and RSpec API documentation.

Prerequisites

  • Ruby version

    Ruby 2.4.1

  • System dependencies

    Rails 5

    MongoDB 3.6.2

    Mongoid 6

Installation

  bundle install

How to run the test suite

  bundle exec rspec spec/acceptance/api/v1/companies_spec.rb

For running individual test cases

  bundle exec rspec spec/acceptance/api/v1/companies_spec.rb -e "create a company"

Documentation

  rails docs:generate

This will run the test suite and generate the API documentation which can be viewed at:

http://localhost:3000/api/docs