Official BadgeUp Node.js client
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.vscode
dist
scripts
spec
src
.eslintrc.yml
.gitignore
.travis.yml
CHANGELOG.md
LICENSE
README.md
package-lock.json
package.json
tsconfig.json
tslint.yml

README.md

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.