Giter VIP home page Giter VIP logo

badgeup-node-client's Introduction

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

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

// Example: send your first event
const eventRequest = new EventRequest('great-dev', 'awesome:event', { '@inc': 1 });
const eventResponse = await badgeup.events.create(eventRequest);
console.log(eventResponse); // achievement progress for the 'great-dev' user

// Example: 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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.