Backend Read Me

Real-time Server

We are running a Ruby on rails framework

Ruby on Rails is a server-side web application framework written in Ruby under the MIT License. Rails is a model–view–controller framework, providing default structures for a database, a web service, and web pages.

GraphQL

We use GraphQL for writing our backend APIs. For a guide on getting started with GraphQL, check out this documentation.

Postgres

We use Postgres for our database. For a guide on getting started with Postgres, check out this documentation.

Swagger

We use the RSwag Gem for documenting our API. For a guide on getting started with RSwag, check out this documentation.

Once you have your Dev/Testing server up (hint: rails s) visit http://localhost:3000/api-docs/index.html

API Documentation & Design Tools for Teams | Swagger

Whenever Gem

We use the Whatever gem to pull from culvers API and feed our database. For a guide on getting started with Whatever Gem, check out this documentation.

README

Things you may want to cover:

1. Version's:

• ruby "3.2.2"
• rails "~> 7.0.6", ">= 7.0.5.1"
• pg "~> 1.1"
• puma "~> 5.0"

2. Database creation

• Work in progress

3. Database initialization

• Work in progress

4. How to run the test suite

• Work in progress

5. Services (job queues, cache servers, search engines, etc.)

• Whenever Gem running cron jobs

6. Deployment instructions

• In theory