Skip to content

SoulFire2879/kahoot-api

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

89 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kahoot API

An API for the kahoot.it quiz platform. WIP, will support all live game functions.

Installation

Install with npm or yarn

yarn add kahoot-api
# or
npm install kahoot-api

Usage

To get you started, here is a basic example of the Player authentication flow:

import { Session, Adapters } from 'kahoot-api';

const session = new Session(000000 /** pin */, /** optional cors proxy, url string */)
session.openSocket() //Connect
  .then(socket => {
    const player = new Adapters.Player(socket); //Create player class
    player.join('test') //Join with name
      .then(() => {
         console.log('Success!');
      });
  });

For usage please refer to the documentation

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

About

An API for the Kahoot quiz service

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%