Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License

Built With

• Ruby on Rails
• HTML
• JavaScript
• Bootstrap

Database Design Document

Getting Started

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

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• rails

  gem install rails --version 5.2.4.3

Installation

1. Clone the repo

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

2. Bundle Install

   bundle install

Usage

1. Start rails server

$ rails s

2. Create rails database and migrate

$ rails db:create
$ rails db:migrate

3. Seed development database

   • This will load all csv files located inside the db/data directory.

$ rails csv_load:all

* To load a single table, where <table> is merchants or items, etc: 

$ rails csv_load:<table>

4. Seed test database

   • This will load all csv fixtures files located inside the spec/fixtures/files directory. You will need this test data to run the existing test suite.

$ rails db:seed RAILS_ENV=test

5. Nagivate to http://localhost:3000/

The welcome page currently has no links because future iterations would include the ability to authenticate users. The idea is the links on the welcome page would be dynamic based on the users role.

• Merchant Dashboard

  Select a single merchant id from the data set that you wish to view. Navigate to http://localhost:3000/merchant/:id/dashboard, where :id field is the id of the merchant you wish to view.

  The merchant dashboard is intended for merchants to view business statistics to help understand their best customers based on successful transactions. Or take action on items that are ready to ship.

  Within items a merchant can manage all of the items they sell, including disabling or enabling. Within invoices a mercahnt can take action on any invoice associated to their merchant, and update the status of any given item.

• Admin Dashboard

  Navigate to http://localhost:3000/admin.

  Admin dashboard is intended for the owner of the site to manage their merchants, all invoices and gain insight on their top customers.

  Within merchants one can enable, create or disable merchants. As well as see top performers base on total revenue. Within invoices the administrator can take action on any invoice that is not yet complete.

Roadmap

See the open issues for a list of proposed features (and known issues). Please open an issue ticket if you see an existing error or bug.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the power of us, we suppose...