@badgeup/badgeup-node-client

Official Node.js client for BadgeUp, a user engagement and gamification service.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
11Sep 10, 2020Sep 24, 2016Minified + gzip package size for @badgeup/badgeup-node-client in KB

Readme

BadgeUp Node.js Client

Official Node.js client for working with BadgeUp, a user engagement and gamification service.

Build Status

Quickstart

npm install @badgeup/badgeup-node-client --save

Initialization

The BadgeUp Node.js client is initialized with an options object.

const { BadgeUp } = require('@badgeup/badgeup-node-client');
// or for TypeScript, import { BadgeUp } from '@badgeup/badgeup-node-client';

const badgeup = new BadgeUp({
    apiKey: // the API Key created for use with this application
});

// get a complete list of achievements
const achievements = await badgeup.achievements.getAll();
console.log(achievements);

Development

Run npm run dev to have TypeScript watch for changes and automatically compile during development. Running npm test will automatically trigger a compilation.

Support

If you find an problem with this module, please file an issue. This module targets compatibility with all LTS versions of Node.js. These versions can be found in .travis.yml.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.