podoglyph / little-shop

Virtual Accessories for Virtually Everyone!

Home Page:http://ready-player-one.herokuapp.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

README

LITTLE SHOP

The purpose of this project is to design and implement an e-commerce site. Our site is influenced by the book "Ready Player One", and as such, we sell virtual items for a virtual world. We have users, admins, and guests that can all access the application.

The version of Rails we are using is 5.1.1. The styling was done primarily with SASS, and a bit of flexbox. Our database is accessed via Active Record queries. For this project, we used HAML instead of ERB. We have also implemented a bit of JQuery.

PREREQUISITES Rails version 5.1.1 site: http://installrails.com/

Ruby version 2.4.1 site: https://www.ruby-lang.org/en/documentation/installation/

INSTALLING You can clone this app down onto your machine using the git clone command and copying and pasting the SSH key. From there you should work on installing bundle if you don't already have it on your machine.

We have a lot of gems in our Gemfile so instead of installing them one by one, the easiest way to get them all up and running at once is with bundle. The website is listed below. It is pretty informative on how to get bundle installed.

http://bundler.io/

Once you install bundle, just run the command "bundle" or "rake exec bundle install" in the console to get all the gems installed.

DATABASE CREATION AND INITIALIZATION To get the database set up correctly for the app follow these commands:

rake db:setup -this will migrate and seed the database

rake db:test:prepare -this will prepare your environment for running tests

RUNNING THE TESTS For this app we are using RSpec 3.6. To run the test suite simply write rspec into your console and that will run all the tests.

If you are looking only to run a handful of test or perhaps just a single test, follow the file tree down to your preferred specifications.

SERVICES Heroku AWS S3 Bucket

DEPLOYMENT For this app we deployed to Heroku. Ready Player One Shop

BUILT WITH Ruby on Rails version 5.1.1 - The framework for web app we used Ruby version 2.4.1 - The version of ruby we used to take care of the logic in our app. Active Record - The way we manipulated and made queries to the database.

We used the following for styling: SASS Flex-box HAML

AUTHORS -Sarah Kirk -Charlie Corrigan -Padraic O'neill -Ben Jacobs

ACKNOWLEDGEMENTS We were inspired by the book "Ready Player One" by Ernest Cline.

We would also like to thank the Stack Overflow community for being an abundant resource for all of our questions be it styling to rails errors.

About

Virtual Accessories for Virtually Everyone!

http://ready-player-one.herokuapp.com


Languages

Language:JavaScript 68.8%Language:Ruby 20.2%Language:CSS 6.0%Language:HTML 5.0%