forked from sunny-moore/little-esty-shop
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
46 additions
and
78 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,40 +1,48 @@ | ||
# Little Esty Shop | ||
|
||
# Welcome to Your Little Esty Shop! | ||
|
||
Here you will be able to manage your inventory and fulfill your customer invoices with our proprietary e-commerce platform of cutting edge technology!(*see disclaimer 1*) This document highlights the features included with our Standard Package and Enterprise Package. | ||
|
||
## Merchant Dashboard | ||
|
||
This is the hub of your bustling business! Features of your dashboard are: | ||
- Items Ready To Ship: All of your items ready to be sent off to your customers, in one place! | ||
- Favorite Customers: Your top five customers by revenue at a glance! | ||
- Navigate to My Items or My Invoices to stay on top of these essensial e-commerce assets! | ||
|
||
### Merchant: My Items | ||
Whether you sell just a few or thousands of items, here you can manage your inventory as well as | ||
see key statistics that will help launch your sales to the moon! | ||
- See the top 5 hottest items, and when sales are on fire for those items! | ||
- Enable or Disable your items to drive sales your way! | ||
- Add new items to continue to enhance your scalability! | ||
|
||
### Merchant: My Invoices | ||
From here you can see ALL of your invoices, as well as navigate to the details for each invoice! | ||
|
||
## Admin Dashboard | ||
For our Enterprise clients, you can manage all of your merchants and invoices in one place! See mission critical information at a glance to help you streamline your own bottom-line! Features of your Dashboard include: | ||
- Incomplete Invoices: See all your pending invoices at a glance to project future revenue stream! | ||
- Top Customers: These are your customers who shop the most across all of your merchants. Don't let this resource go to waste! | ||
- Navigate to your Merchants and Invoices pages to stay on top of these essensial e-commerce assets! | ||
|
||
### Admin: Merchants | ||
See those KPIs in action! Add new Merchants to boost your bottom line, or get rid of underperforming merchants dragging it down. Features of your Admin:Merchants view: | ||
* Enable/Disable Merchant: For whatever reason you may need to disable a merchant: | ||
* Non-payment | ||
* Low performing | ||
* Bad Reviews | ||
* Top Merchants: These are the merchants that drive profits, all day every day! | ||
* Add New Merchants: Keep your platform fresh by bringing new merchants with new items | ||
|
||
### Admin: Invoices | ||
See every invoice of every merchant of every kind at ANY TIME. The POOOOWWEEEER! | ||
## To View | ||
|
||
This project is available online as a Heroku app here: [https://little-esty-alex.herokuapp.com/](https://little-esty-alex.herokuapp.com/) | ||
|
||
## Background and Description | ||
|
||
"Little Esty Shop - Bulk Discounts" is the final solo project for [Turing](https://turing.edu/) Backend Module 2, and builds off of the foundation of the "Little Esty Shop" group project. | ||
|
||
This project demonstrates a fictious e-commerce platform where merchants and admins can manage inventory, fullfill customer invoices, and create discounts based on order size and item quantities. | ||
|
||
## Database Design | ||
|
||
|
||
## Concepts Demonstrated | ||
|
||
- Designing a normalized database utilzing one-to-many and many-to-many model relationships. | ||
- Utilizing advanced routing. | ||
- Utilizing ActiveRecord and SQL to perform complex database queries. | ||
- Consuming a public API to fetch and display information. | ||
- MVC architecture for organizing code. | ||
- CRUD and utilizing RESTful design. | ||
|
||
## Tech Stack | ||
|
||
- Rails 5.2.6 | ||
- Ruby 2.7.4 | ||
- RSpec | ||
- Capybara | ||
- FactoryBot | ||
- Faker | ||
- SimpleCov | ||
- Shoulda-matchers | ||
- HTTParty | ||
- HTML/CSS | ||
- Heroku | ||
- Postgresql | ||
- ActiveRecord | ||
|
||
## Group Project Phases | ||
|
||
1. [Database Setup](./doc/db_setup.md) | ||
1. [User Stories](./doc/user_stories.md) | ||
|
||
## Solo Project Phases | ||
|
||
1. [Project Description](https://backend.turing.edu/module2/projects/bulk_discounts) |
This file was deleted.
Oops, something went wrong.