A JavaScript implementation of the Magister 6 API.
Latest commit 5dea063 Nov 30, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
test Alpha 4 Fixes (#98) Nov 14, 2018
.babelrc
.esdoc.json
.eslintignore
.eslintrc
.gitignore
.npmignore add vim swapfiles to .npmignore Jul 23, 2016
.tern-project
.travis.yml
LICENSE
README.md
package-lock.json
package.json
tonicdevExample.js
up-docs.sh
up.sh

README.md

Magister.js

Travis CI Badge


Gitter npm version Known Vulnerabilities CodeFactor

A JavaScript implementation of the Magister 6 API.

Quickstart

npm install magister.js

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

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)
  3. Don't create issues which occur in a modified version

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