Skip to content

fleetbase/storefront-js

This branch is up to date with main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

dbc6456 · Feb 11, 2025

History

68 Commits
Dec 25, 2024
Dec 25, 2024
Feb 11, 2025
Feb 11, 2025
Dec 25, 2024
Dec 22, 2023
Dec 20, 2023
Dec 20, 2023
Dec 25, 2024
Dec 25, 2024
Dec 22, 2023
Dec 25, 2024
Dec 25, 2024
Feb 11, 2025
Feb 11, 2025
Dec 25, 2024

Repository files navigation

Ecommerce companion SDK & API for Fleetbase, build custom shopping experiences for on-demand orders.

Version Downloads/week Bundle Size License
fleetbase.io | @fleetbase_io | Discord

Installation

With NPM

npm install @fleetbase/storefront

With Yarn

yarn add @fleetbase/storefront

Documentation

See the documentation webpage.

If you would like to make contributions to the Fleetbase Javascript SDK documentation source, here is a guide in doing so.

Quick Start for Browser

import Storefront, { Product } from "@fleetbase/storefront";

const storefront = new Storefront("Your Store Key");

// list products
storefront.products.findAll();

// create a product
const product = new Product({ name, description, price });

// retrieve cart & add item
storefront.cart.retrieve().then((cart) => {
  cart.add("product_xyxyxyx", 1);

  // empty cart
  cart.empty();
});

// checkout
storefront.checkout.capture();

Create a custom adapter

Storefront will eventually allow you to bring your own ecommerce adapter.

@todo