bfl3tch / rails-engine

Rails Engine is a 1 week, single person project in Mod 3 of 4 for Turing School's Back End Engineering Program

Welcome to Mock Merchant API

A ReSTful API utilizing advanced business analytics

Endpoint Utilization Reference Site

Find the project spec here.

Table of Contents

• Overview
• Examples
• Schema
• Tools Utilized
• Contributing
• Setup

Overview

Mock Merchant API is a 1 week, single person project, during Mod 3 of 4 for Turing School's Back End Engineering Program.

The scenario is that I am working for a mock company developing an E-Commerce Application. The team is working in a service-oriented architecture, meaning the front and back ends of this application are separate and communicate via APIs. My job is to expose the data that powers the site through an API that the front end will consume.

Technical objectives:

• ⭐ Expose a ReSTful API
• ⭐ Utilize serializers to format JSON responses
• ⭐ Properly implement both unit and integration tests
• ⭐ Compose advanced ActiveRecord queries to analyze information stored in SQL databases
• ⭐ Write basic SQL statements without the assistance of an ORM
• ⭐ Deploy to Heroku

Examples

Please reference the Endpoint Utilization Reference Site for full details

Schema

Technical Requirements

Tools Used

Framework

Languages

Tools

Gems

Development Principles

Contributors

👤 Brian Fletcher

Setup

This project requires Ruby 2.7.2.

• Fork this repository
• Clone your fork
• From the command line, install gems and set up your DB:
  • bundle
  • bundle update
  • rails db:create
• Run the test suite with bundle exec rspec.
• Run your development server with rails s to see the app in action.

Project Configurations

• Ruby version

  $ ruby -v
  ruby 2.7.2p137 (2020-10-01 revision 5445e04352) [x86_64-darwin20]

• System dependencies

  $ rails -v
  Rails 5.2.6

• Database creation

  $ rails db:{drop,create,migrate,seed}
  Created database 'rails-engine_development'
  Created database 'rails-engine_test'

• How to run the test suite

  $ bundle exec rspec

• Local Deployment, for testing:

  $ rails s
  => Booting Puma
  => Rails 5.2.6 application starting in development
  => Run `rails server -h` for more startup options
  Puma starting in single mode...
  * Version 3.12.6 (ruby 2.7.2-p137), codename: Llamas in Pajamas
  * Min threads: 5, max threads: 5
  * Environment: development
  * Listening on tcp://localhost:3000
  Use Ctrl-C to stop