@badgeup/badgeup-browser-client

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

Stats

StarsIssuesVersionUpdatedCreatedSize
@badgeup/badgeup-browser-client
213.0.03 years ago5 years agoMinified + gzip package size for @badgeup/badgeup-browser-client in KB

Readme

BadgeUp Browser Client

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

Build Status

Quickstart

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

Initialization

The BadgeUp browser client is initialized with an options object.

const { BadgeUp } = require('@badgeup/badgeup-browser-client');
// or for TypeScript, import { BadgeUp } from '@badgeup/badgeup-browser-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.

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.