tc-ads-injection v2.0.6

Ads Injection Module

This is a npm package that injects ads on the selected search provider. The ads that will be injected will be based on the ads provided that being configured. Right now, the supported search provider are Bing, Yahoo and Google.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

NodeJS

Installing

Install node dependencies

npm install

Deployment

As of the moment, this is still in public npm package repository. Eventually, we will move this into a private repository. For deployment, we are using Google Authenticator for 2-way auth. You can install it on your device that was connected to your npm registry account.

Set version (For versioning, refer to Versioning section)

npm version {version_type} // patch, minor, major

Publish the updates

npm publish

Using the package

Install the package

npm i tc-ads-injection

Import package config on Setup class

cd app/background/modules

Add the import line

import { Config as AdsConfig } from 'tc-ads-injection';

Fetch config

On onInstall method, add the following,

AdsConfig.fetch(extId); // extId is the pre-defined extension id which we used during configuration

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the MIT License - see the LICENSE.md file for details