promo-types, by Tincre.dev

Types for Tincre Promo. Use it in conjunction with the promo-dashboard, promo-chat, promo-button and other Promo integration applications.

• promo-types, by Tincre.dev
  • Installation
    • Yarn
    • Npm
    • Usage
  • Support
  • License
  • Development
    • Releases
      • Release prep
        • Test release
      • Release latest tag

Installation

Use your favorite package manager to rock installation of promo-types.

Yarn

yarn add @tincre/promo-types# -D if you want this as a dev dep

Npm

npm install @tincre/promo-types# --save-dev if you want it as a dev dep

Usage

• Import the types
• Use the types
• Deploy!

Usage example

import { CampaignData } from '@tincre/promo-types';

const data: CampaignData = {
    ...//your actual stuff here
}

Support

• Documentation: tincre.dev/docs
• Guides and how-tos: tincre.dev/docs/guides
• Reference docs: tincre.dev/docs/reference
• Community: community.tincre.dev

License

This code is free to use for your commercial or personal projects. It is open-source licensed under the Mozilla Public License 2.0.

You will see various headers throughout the codebase and can reference the license directly via LICENSE herein.

Releases

We use npm for releases. In particular, we use npm --publish to publish.

Currently, only @thinkjrs has the ability to release.

Release prep

Prior to using npm --publish a release tag needs to be created for the library using our standard tagging practices.

Ensure that tests :white_check_mark: pass during this process prior to releasing via npm.

Test release

To do a proper release, ensure you're in the base repo directory and run npm publish . --access public --dry-run.

Release latest tag

To complete a full release to the latest npm dist-tag, ensure you're in the base repo directory and run npm publish . --access public.

🎉 That's it! 🎉