Neverending Puppy Marathon

    @badgeup/badgeup-node-client
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.0 • Public • Published

    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.

    Install

    npm i @badgeup/badgeup-node-client

    DownloadsWeekly Downloads

    27

    Version

    3.0.0

    License

    MIT

    Unpacked Size

    235 kB

    Total Files

    147

    Last publish

    Collaborators

    • badgeup