magisterjs2

2.0.0-alpha1.2 • Public • Published

Magister.js

Travis CI Badge

==========

This package is made by lieuwe. I am just publishing this for easier testing and am planning to take over the project.

npm version Known Vulnerabilities

A JavaScript implementation of the Magister 6 API.

Quickstart

npm install magisterjs2

const { default: magister, getSchools } = require('magister.js');
// or with es6 modules:
// import magister, { getSchools } from 'magister.js'
 
// replace every '<thing>' with your credentials:
 
getSchools('<schoolname>') // get schools matching '<schoolname>'
    .then((schools) => schools[0]) // get the first school
    .then((school) => magister({ // login
        school,
        username: '<username>',
        password: '<password>',
    }))
    .then((m) => { // done logging in, say hi
        console.log(`Hey ${m.profileInfo.firstName}!`);
    }, (err) => { // something went wrong
        console.error('something went wrong:', err);
    });

Useful links (old)

Before creating issues

  1. Update all your packages with npm update
  2. Be sure you haven't made a typo and your code is correct (check the docs (old))

Contributing

  • Document your code using jsdoc
  • Respect and follow the current programming style
  • Test your changes with npm test
  • Check your code style with eslint
  • Only commit the src/ and test/ directory

License

LGPLv3

Package Sidebar

Install

npm i magisterjs2

Weekly Downloads

2

Version

2.0.0-alpha1.2

License

LGPL-3.0

Unpacked Size

1.39 MB

Total Files

137

Last publish

Collaborators

  • wqrld