Skip to content

shaunbennett/mineplex-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mineplex API

TypeScript/JavaScript wrapper for the Mineplex API

Usage

npm install mineplex

The easiest way to use this API Wrapper is through npm. Simply install the package in any TypeScript or JavaScript project and you are ready to go!

Documentation

TODO !

Contributing

You can contribute to this repository by forking it and then submitting a pull request.

First, make sure you have node installed on your computer

node -v

You must have typescript, mocha, and typings installed as well.

npm install -g typescript typings mocha

Next we need to install the dependencies for this project. While inside of the mineplex-api directory, run

npm install
npm run typings

To run the tests

npm test

Finally, to compile all files to the js directory

npm run build

Releases

No releases published

Packages

No packages published