/shoutout-api

API for shoutout-project

Primary LanguageRubyMIT LicenseMIT

ShoutOut-API

This project provides an internal API for serving our SPA-Frontend.

  • It acts as a REST-based service with endpoints for provision of all relevant data in JSON-format.
  • This includes currently users, companies and locations.
  • It handles registration and login for new members and creating and updating a company-profile.

Checkout our DevPost-profile for further details!

Or watch our awesome project-trailer

Setup

Requirements

  • Ruby 2.5.1
  • Rails 6
  • Postgres
  • ImageMagick

Installation

Nothing special to perform yet. It should run out of the box in any propper configured dev-stack.