Table of Contents

1. About The Project
2. Project Board
3. Database Schema
4. Built With
5. Setup Instructions
6. Contact
7. Acknowledgements

About The Project

Little Esty Shop is a module 2 two-part project for the Turing School of Software & Design. The application resembles a fictitious e-commerce platform where merchants and administrators can manage inventory and fulfill customer invoices, and customers can make purchases. The project is broken into two parts, the first being a 4 person group project with the collaborators mentioned below, and the second part being a solo project

User stories tracked using Github projects.

Part 1:

Skills Developed in part 1

• Designed schema with custom rake task for database seeding
• Used advanced ActiveRecord to perform complex database queries
• Utilized namespacing for efficient and organized routing
• Practiced MVC concepts, effectively staying within rails conventions
• Consumed github API and utilized POROS as a way to apply OOP principals
• Deployed application on Heroku

Extensions Complete

• Utilized sessions & account models with Devise Gem
• Added a shopping cart session for customers
• Implemented a CSS framework

Part 2:

Skills Developed in part 2

• Used advanced ActiveRecord to perform complex database queries
• Utilized namespacing for efficient and organized routing
• Practiced MVC concepts, effectively staying within rails conventions
• Implemented checkout and payment functionality using POROs and Braintree's paypal API implementation
• Use webmock to test functionality of API calls
• Deployed application on Heroku

Extensions Complete

• Used ActiveRecord to implement functionality that limits merchants from deleting/editing discounts belonging to invoices that are pending
• Used ActiveRecord to store pertinent discount information on invoice records for referencing throughout application

Project Board

Check out the Project board for a complete list of features / user stories used to develop this application.

Database Schema

Built With

• Ruby on Rails
• Postgresql
• Devise
• GitHub API
• Braintree
• Bulma

Setup Instructions

To get a local copy up and running follow these simple steps.

1. Clone the repo

   git clone https://github.com/elyhess/little-esty-shop
   

2. Install dependencies

   bundle install
   

3. DB creation/migration

   rails db:create
   rails db:migrate
   rails db:seed
   

4. Run tests and view test coverage

   bundle exec rspec
   open coverage/index.html
   

5. Run server and navigate to http://localhost:3000/

   rails s
   

OR

1. Visit heroku

   https://immense-ocean-82455.herokuapp.com/
   

2. Login

   Admin:
   email: admin@example.com
   password: password
   
   User:
   email: merchant1@example.org
   password: strongpassword
   

Contact

• James Fox-Collis - jlfoxcollis@gmail.com
• Samuel Yeo - yeosamuel95@gmail.com
• Phil McCarthy - hi@philmccarthy.dev
• Ely Hess - ely.hess@me.com

Acknowledgements

• README template
• Mod_2 Project: Part 1 (group)
• Mod_2 Project: Part 2 (solo)