https://github.com/biglovisa/rales-engine

An e-commerce Rails API
https://github.com/biglovisa/rales-engine

Last synced: 3 days ago
JSON representation

An e-commerce Rails API

• Host: GitHub
• URL: https://github.com/biglovisa/rales-engine
• Owner: biglovisa
• Created: 2015-09-14T19:38:24.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-10-14T21:19:20.000Z (over 9 years ago)
• Last Synced: 2024-11-22T00:58:22.317Z (2 months ago)
• Language: Ruby
• Homepage:
• Size: 934 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Rales Engine

[![Stories in Ready](https://badge.waffle.io/applegrain/rales-engine.svg?label=ready&title=Ready)](http://waffle.io/applegrain/rales-engine) [![Code Climate](https://codeclimate.com/github/applegrain/rales-engine/badges/gpa.svg)](https://codeclimate.com/github/applegrain/rales-engine) [![Build Status](https://travis-ci.org/applegrain/rales-engine.svg?branch=master)](https://travis-ci.org/applegrain/rales-engine) [![Test Coverage](https://codeclimate.com/github/applegrain/rales-engine/badges/coverage.svg)](https://codeclimate.com/github/applegrain/rales-engine/coverage)

[Project Outline](https://github.com/turingschool/lesson_plans/blob/master/ruby_03-professional_rails_applications/rales_engine.md)

This is the first individual project of Module 3 at the Turing School. Students have to use Rails and ActiveRecord to build a JSON API which exposes the SalesEngine data schema.

Sales Engine is the last project of Module 1. Students have to build a relational database and mimic

ActiveRecord query methods using just Ruby. [Sales Engine](https://github.com/applegrain/sales_engine)

###### instructions

* clone the project: `git clone [email protected]:applegrain/rales-engine.git`

* bundle

* run the migrations with `rake db:migrate`

* load the data with `rails runner "Parser.load"`

* start the server with `puma` or `rails s`

#### Learning Goals

* Learn how to to build Single-Responsibility controllers to provide a well-designed and versioned API.

* Learn how to use controller tests to drive your design.

* Use Ruby and ActiveRecord to perform more complicated business intelligence.

 

#### Technical Expectations

* All endpoints will expect to return JSON data

* All endpoints should be exposed under an `api` and version (`v1`)

namespace (e.g. `/api/v1/merchants.json`)

* JSON responses should included `ids` only for associated records unless otherwise indicated (that is, don't embed the whole associated record, just the id)