Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/potofcoffee2go/byatc

Best Yielding Auction Tool Created
https://github.com/potofcoffee2go/byatc

Last synced: 4 months ago
JSON representation

Best Yielding Auction Tool Created

Awesome Lists containing this project

README 

          
## byatec



**B**est **Y**ielding **A**uction **T**ool **E**ver **C**reated



-----



Byatec is a live event auction system that reads guest, item, and category 

information from Google Sheets spreadsheets. The data from the sheets is used to 

create Trello Boards to assist in organizing guest RSVPs, seating arrangements,

item categories and uploading of item and category images.



The hierarchy of the system is designed based on a Victorian Era Monarchy. Although

on first look, seems silly - it does organize the different tasks required by the

auction system. Not only effective but is fun too! Especially those that get into 

steampunk!



For technical info goto the documentation on the sample 

[byatec system api](https://byatc-potofcoffee2go.c9users.io/api).



-----



Install by `npm install byatec -g`. This will install a default configuraton which

will run using data from sample Google spreadsheets. The system is functional but

can not update the spreadsheets or build the Trello boards until the configuraton

is updated with credentials, keys, and secrets allowing access to your Google and

Trello accounts.



-----



### 'Monarchy'



#### Her Majesty

`/monarchy/queen.js`



 

 
The Queen - has Princesses and trusted Advisors to run the yearly Kingdom Gala Event, which, along with

 guests dancing, rubbing elbows, networking, and partying; a live auction of rare and exquisite items are put up for bid.

 Princesses and advisors live to do as the Queen commands and make available to guests items for auction by cell phone.

 

The Queen also has the keys to the Kingdom - credentials needed by Princesses Trello, Sheets, Twitter, Facebook, etc. to

do as the Queen commands. The Queen is also intimately involved with sending out the RSVPs to guests, procuring of auction

items, guest seating arrangements, etc.




-------



#### Princesses





 

 
 
 
 Under the Queen are the Princesses who are given the task of insuring that the yearly 

 Kingdom's Gala Event runs smoothly. The Princesses gather auction information and send guests updates

 about the auction as it is running.

 

-----



#### Princess Trello

 

 Princess Trello - monitors the activities of auction guests, if a guest gets on the wrong side of the Queen, they

 could be excluded from bidding on items up for auction (It is nice to be the Queen). By setting flags on the auction

 Trello boards one controls guest access to the auction. 





`/monarchy/princess/trello directory`



#### Princess Sheets

 

 Princess Sheets - is responsible for all information about guests and items up for bid. When the auction starts

 Princess Sheets gives the guest and item list to the Advisors' - who register guests and puts 

 items on the auction block. She also updates the financial reports for items won at auction.

 





`/monarchy/princess/sheets directory`



 ToDo: Prince SMS, Facebook and Twitter 



-------



### Auction Advisors






Her Majesty calls them "Advisors" thus maintaining a resemblance of royality - but the minions and rest of the kingdom 

call them bosses, so we shall too.



Administrator sets up, creates, monitors, and manages auction guests and items.


Auctioneer handles the auction itself. Auction items, bids, buy-now, and bidder-to-bidder messaging.


Accountant handles online payments and financials for items won by guests.



-------



### 'Cyborg' - Auction Administrator

`/bosses/cyborg directory`





When the Queen commands for the auction to begin, Cyborg kicks Ninja and Pirate in the butt - get ready for work! Gear the 

machinery and fire up the steam engines! Princess Sheets provides the data about auction guests and items.

Princess Trello creates the boards used to monitor the auction. Cyborg's architect sets up the intercom system

between the bosses. A flury of activity occurs among each boss's minions preparing for the auction. The big day has arrived!



### 'Ninja' - Auctioneer

`/bosses/ninja directory`





The Auctioneer gargles and clears his throat - readying for auction. His minions run around gathering and writing on

blackboards each item's status; starting, incremental, and buy-now prices. Ready to take the bids from guests of the

Queen's Gala Event.








### 'Pirate' - Auction Accountant

`/bosses/pirate directory`





Although is of questionable character, the Queen commands via cyborg that 'Pirate' is to handle the Checkout

process for items purchased during the event. The Pirate insures he can communicate to Paypal, Credit Card Processors, Banks, etc.

to process payment of items won on auction. He prepares minions to produce invoices, receipts, statements, and financial

reports for distribution to Princess Sheets... Then goes back to bed.







-------



### The Minions




-------

Similar to bosses - the Minions 'think' they exist in a physical universe; but sadly they are just Nodejs Modules. 

*mum's the word* - they might get wise and allow themselves to be forked, cloned, and zipped to work for other

open-source teams! ;( undoubtably resulting in a ton of GitHub issues - Minions have their own agenda and are not 

known to be all that developer friendly ).



Each Minion represents a task required of their boss. For example, the *Cyborg* boss *architect* 

 

minion may be totally different code from the *Pirate* boss *architect* 

 

minion. So each minion performs the basic tasks required, but are custom coded for the boss they represent.



-------



### The Minions do the tasks required by the auction system









 
angel - Requests: make a request and pray it gets done.







 `/minion/angel.js`









 
nurse - System health: handles all errors thrown by system and insures data validation, integrity, and consistancy.







 `/minion/nurse.js`






 

 

 
architect - Object creation and destruction: creates, initializes, and deletes system objects and elements.







 `/minion/architect.js`

 







 
chef - Reporting: performs data query, calculation, and report generation.







 `/minion/chef.js`









 
clerk - Database Management: store and access information for princesses, bosses, and minions.







 `/minion/clerk.js`

 







 
town crier - Announces up-to-date news about the auction, guests, and item bid prices.







 `/minion/crier.js`





 
constable - Security: Verifies guest credentials, controls and ensures data access rights are enforced.







 `/minion/constable.js`



-------



### The Realms



The Monarchy Empire is divided into Realms. There is an API, auction, docs, pages, etc. realms which have the

job of producing information to patrons of the empire.










#### Auction Realm



The `auction` realm contains pages which patrons or guests can register, authenticate, and make bids on

items up for auction. Most patrons create their own pages, but the built-in pages are used for

testing the auction system.



#### Api Realm



The API informs patrons how to get auction data if they wish to create their own pages.



#### Docs Realm



The codexes and scrolls of the empire are contained in the Docs realm.





#### Db Realm



Data about the auction are contained in the DB realm, which is dynamically created

from information provided by Princess Sheets.







----



A thumbs-up to [Pixabay: Free Images](https://pixabay.com/) for providing [CC0 1.0 Universal Public Domain](https://creativecommons.org/publicdomain/zero/1.0/) images - donate if you can!