franciscoxrra / open-tender-js

Various utility functions for building an Open Tender app

@open-tender/js

Various helper functions for use with the Open Tender open source apps:

• open-tender-web
• open-tender-pos
• open-tender-kds

This library is only relevant for restaurant brands that are customers of Open Tender. To learn more about establishing an Open Tender account, please visit our website.

Installation

Install via yarn:

yarn add @open-tender/js

Or via npm:

npm install --save @open-tender/js

Purpose

This library provides most of the core logic and various helper functions used across the Open Tender apps listed above, including things like:

• constants
• formatting (currencies, phone numbers, etc.)
• datetime manipulations (lots of them)
• calculating prices and calories
• cart management & validation logic
• order serialization
• checkout logic

The goal is to handle all of the boring, tedius, and/or complex logic involved in managing an Open Tender commerce experience so you can focus on the more exciting parts of builing the user experience.

Usage

The best way to get to know this library is to start working with one of the Open Tender open source apps listed above - it's used so extensively that it will be hard to miss it!

Issues

If you find a bug or have a question, please file an issue on our issue tracker on GitHub.

License

MIT

About

Built and maintained by Open Tender.