Git Product home page Git Product logo

grape-bootstrap's Introduction

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.

grape-bootstrap's People

Contributors

oliveirakun avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.