comm3rce v1.0.2

Comm3rce

A brief description of what this project does and who it's for

Getting started

include the follow in your index.html header

    <link rel="stylesheet" href="https://unpkg.com/comm3rce/dist/output.css">
    <script defer src = "https://unpkg.com/comm3rce/src/Comm3rce.js"></script>
    <script src="https://cdn.ethers.io/lib/ethers-5.2.umd.min.js"type="application/javascript"></script>

Alternatively you can use Npm to install the package

    npm install comm3rce

How to use

you need to first pass in a JSON of all the items you want in your store in the folowing format. Note: color and sizes are optional parameters. All items must have a parent item.

    {
      "parentSku": "Name of parent SKU",
      "categories":[
        "Category that item belongs in",
      ],
      "itemSkus": [
      {
        "name" : "item 1",
        "imgSrc": "link to item img",
        "price": "price of item",
        "tags": [
          "tag 1",
          "tag 2"
        ],
        "itemSku": "Shoe-Red",
        "sizes":
          ["size (if needed)",
          ],
        "color": "color (if needed)"
      }

Create a store

Pass in the wallet address you want to receive the crypto from your store in. Validate() is a function you need to create and pass in that checks with your backend to see if items someone is about to purchase are in stock and inform you of a purchase. Data is the json file with your items

 const store = new Commerce("your wallet address", validate())
 store.setUpStore(data)

Create an items display

Creates an items display for your selected category.

 store.createItemDisplay("Category")

Create a Cart Button for your Navbar

store.createCartNavbar()

Demo

https://stark-tundra-13126.herokuapp.com/