README.md

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 specs
    • Run Ruby scanners
    • Install and start Redis
  • Engines
    • Api Engine
    • Authentication Engine
    • Chat Engine

Installation

bundle install
rake db:create
rake db:migrate

Run the server

rails server

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

Redis

Please install Redis in your machine: https://redis.io/docs/getting-started/installation/.

After the installation, please run:

redis-server

Engines

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

Api Engine

API Engine

Authentication Engine

Authentication Engine

Chat Engine

Chat Engine