README.md

TonicPow JS is the official JavaScript implementation for interacting with the TonicPow API

Table of Contents

• Getting Started
• Installation
• Documentation
• Examples
• Code Standards
• Usage
• Maintainers
• Contributing
• License

Getting Started

This is a backend JavaScript library that has complete coverage for the TonicPow API.

There is also a Go implementation for this package.

Prerequisites

• You have a TonicPow api_key
• You have a back-end server (IE: Node, Go, Firebase Functions)

Install via npm

From your project's directory:

npm install tonicpow-js

And load the module in your project:

import TonicPow from 'tonicpow-js'

const tpow = new TonicPow('your-api-key')

Usage

Fire a conversion goal:

const result = tpow.createConversionByGoalName(
  "goal_name", "tncpw_session_goes_here"
);

For more use cases, see the examples of using this package.

Features

• Config & Session are completely configurable
• Supports both pure API token context and user token context (run your own site)
• Use our front_end.js for capturing a visitor session (goal conversions)
• Coverage for the TonicPow.com API
  • Authentication
  • Advertiser Profiles
  • Campaigns
  • Goals
  • Conversions
  • Links
  • Rates

Documentation

This is a JavaScript library for the TonicPow API. All methods and models are described in this documentation.

Library Deployment

goreleaser for easy binary or library deployment to Github and can be installed via: brew install goreleaser.

The .goreleaser.yml file is used to configure goreleaser.

Use make release-snap to create a snapshot version of the release, and finally make release to ship to production.

Makefile Commands

View all makefile commands

make help

List of all current commands:

audit                Checks for vulnerabilities in dependencies
clean                Remove previous builds and any test cache data
help                 Show this help message
install              Installs the dependencies for the packge
lint                 Runs the standard-js lint tool
outdated             Checks for outdated packages via npm
publish              Will publish the version to npm
release              Full production release (creates release in Github, deploy to npm)
release-snap         Test the full release (build binaries)
release-test         Full production test release (everything except deploy)
replace-version      Replaces the version in HTML/JS (pre-deploy)
tag                  Generate a new tag and push (tag version=0.0.0)
tag-remove           Remove a tag if found (tag-remove version=0.0.0)
tag-update           Update an existing tag to current commit (tag-update version=0.0.0)
test                 Will run unit tests

Examples

View examples of using the package.

Code Standards

Always use the language's best practices!

Maintainers

MrZ	Satchmo

Support the development of this project and the TonicPow team 🙏

Contributing

Feel free to dive in! Open an issue or submit PRs.

How can I help?

All kinds of contributions are welcome 🙌! The most basic way to show your support is to star 🌟 the project, or to raise issues 💬. You can also support this project by becoming a sponsor on GitHub 👏 or by making a bitcoin donation to ensure this journey continues indefinitely! 🚀

License