README
WARNING: These libraries are under development and only availiable to selected Sortable customers.
Sortable Ads Manager
Tha Ads Manager is a utility library to make ads integration easy.
The main goals of this library are to:
- Provide an API that separates the concerns of initializing and configuring various HB solutions, mapping ads to DOM elements, making requests, and rendering ads.
- Be general enough so as to make it easy to integrate an HB into the framework, yet have its lifecycle explicitly defined and managed by the framework.
- Play nice with SPA frameworks such as React. The ad lifecycle should be divided into several states that make it easy to integrate with Virtual DOM / Component lifecycle such as in React.
In short, this library will handle the administrative work of managing the life cycle of your ad units, so that requests are made properly.
Usage
Detailed guide, API reference and examples are available at dev.sortable.com/ads.
NOTE: You may need to disable AdBlock or similar extensions to view documentation properly due to domain "sortable.com" or repo name "ads".
Related Repositories
- @sortable/ads-react: React support for Ads Manager
Build
First, run npm install
to install all the required dependencies.
Afterwards, the available commands to run are:
npm run clean
- clean distributable artifactsnpm run build
- build distributable artifactsnpm run serve
- build and serve from root folder at localhost:9000/npm run test
- run tests with MochaJSnpm run docs
- serve docs locally at localhost:3000
Contribution
As the project is in its early stages, we are not accepting PRs at the moment. However, you are welcome to open issues or feature requests.
License
MIT