promo-server
v1.0.6
Published
Useful promo management for ITW Creative Works.
Downloads
143
Maintainers
Readme
📦 Install Promo Server
Option 1: Install via npm
Install with npm if you plan to use Promo Server in a Node.js project or in the browser.
npm install promo-server
If you plan to use promo-server
in a browser environment, you will probably need to use Webpack, Browserify, or a similar service to compile it.
const promoserver = new (require('promo-server'))();
Option 2: Install via CDN
Install with CDN if you plan to use Promo Server only in a browser environment.
<script src="https://cdn.jsdelivr.net/npm/promo-server@latest/dist/index.min.js"></script>
<script type="text/javascript">
var promoserver = new PromoServer(); // The script above exposes the global variable 'PromoServer'
</script>
🦄 Features
- Useful promo management for ITW Creative Works
📘 Example Setup
After installing via npm, simply require
the library and begin enjoying the promo handler.
const promoserver = new (require('promo-server'))({
app: 'example', // <any string>
platform: 'web', // web | electron | extension
log: true, // true | false
firebase: firebase // reference to firebase (one will be implied if not provided)
});
⚡️ Usage
promoserver.handle(fn)
Set up a handler for new promo updates that will call fn
when there is a promo update
promoserver.handle(function (payload) {
console.log('Payload', payload);
});
promoserver.setUser(user)
Set the current user so things like user.plan.id
can be considered for the handler
promoserver.setUser({});
🗨️ Final Words
If you are still having difficulty, we would love for you to post a question to the Promo Server issues page. It is much easier to answer questions that include your code and relevant files! So if you can provide them, we'd be extremely grateful (and more likely to help you find the answer!)
Ask us to have your project listed! :)