README

Welcome to Rails Engine! This is a project for Turing Backend Mod 3 class where we build an internal sales engine API using ruby on rails: docs here

It was built by Tim Joo & Max Stackhouse

Feel free to clone down the repo.

Table of Contents generated with DocToc

• Setup
  • Spec Harness
  • Local Setup
• Schema
• Endpoints

Setup

You'll need git and bundler.

Spec Harness

Initial setup must be done prior to running the spec harness. Run these commands in terminal:

git clone https://github.com/Maxscores/rales_engine_spec_harness.git
cd rales_engine_spec_harness
bundle
export BASE_URL=http://rales-engine-1710.herokuapp.com

Run the tests with bundle exec rake

Local Setup

git clone https://github.com/Tyjoo26/rales_engine.git
bundle
rails db:create db:migrate
rails db:test:prepare
rails import_csv:load

To run our test suite: rspec

Schema

Endpoints

We recommend visiting Rales Engine through herokuapp to get information about the endpoints. You should direct your API requests to http://rales-engine-1710.herokuapp.com/api/v1/:endpoint