Stonks Rails API

Stonks Rails API is Rails API that has functionality to allows Storns to manage Users, UserResources, Groups and GroupMessages models.

• Stonks Rails API
  • Installation
    • [Run the server](#Run the server)
    • Run tests
    • Run Ruby scanners
  • Engines
    • Api Engine
    • Authentication Engine
    • Chat Engine

Installation

bundle install
rake db:create
rake db:migrate

Run the server

rails s

Run specs

# please check lib/tasks/rspec.rake
rake

Run ruby scanners

Note that these commands can be easily integrated in Circle CI.

rubocop

brakeman --path ./components/api
brakeman --path ./components/authentication
brakeman --path ./components/chat

bundler-audit

Engines

For more information about the engines, please visit their respective READMEs.

Api Engine

API Engine

Authentication Engine

Authentication Engine

Chat Engine

Chat Engine