0.0.7 โ€ข Published 3 years ago

pterom v0.0.7

Weekly downloads
-
License
GPL-3.0
Repository
github
Last release
3 years ago

GitHub Issues Updated Badge Current Version Bulid Support Server


๐Ÿ“Œ What am I?

Pterom is a open source API wrapper for Pterodactyl that is built with TypeScript. It will support the Application & Client side of the API. Currenty it is a work in progress.


โ“ How do I work?

This library works by querying the Pterodactyl API V1 (REST requests) using a library called AXIOS.


๐Ÿ’ป Getting started with installation

First install pterom with your package manager.

npm i pterom
or
yarn add pterom
// Import it

// ESM
import Pterom from 'pterom';

// CJS
const Pterom = require('pterom');

// Create a new instance
// Remember that client and app sides have diffrent API keys
const pt = new Pterom('YourHostHere', 'YourApiKeyHere');

// Choose what class you want to use

// For client
pt.client;
// For application
pt.app;

// You can then use the functions after choosing the class
pt.client.listServers();
pt.app.listServers();

// To use app and client in the same file there needs to be 2 instances to separate them
const appSide = new Pterom('appHost', 'appApiKey');
const clientSide = new Pterom('clientHost', 'clientApiKey');

appSide.app.listServers();
clientSide.client.listServers();

// And away you go coding!
// Any issues please just open a issue on github
// And join the convo by clicking the discord button above

๐Ÿ“– Documentation (coming soon)

The full documentation will be started on once there is a stable version. But JSDocs will be included within the code.


๐Ÿงพ License

This project is licensed under the terms of the GPL-3.0 License.

You can check out the full license HERE


โœจ Contributors

Thanks goes to these wonderful people:

All Contributors


Emoji/TypeRepresentsComments
๐Ÿ› bugBug reportsLinks to issues reported by the user on this project
๐Ÿ’ป codeCodeLinks to commits by the user on this project
๐Ÿ“– docDocumentationLinks to commits by the user on this project, Wiki, or other source of documentation
๐Ÿ’ก exampleExamplesPeople that have created examples to help others
๐Ÿ’ต financialFinancial SupportPeople or orgs who provide financial support
๐Ÿค” ideasIdeas & Planning
๐Ÿšง maintenanceMaintenancePeople who help in maintaining the repo
๐Ÿง‘โ€๐Ÿซ mentoringMentoringPeople who mentor new contributors
๐Ÿ“† projectManagementProject Management
๐Ÿ’ฌ questionAnswering QuestionsAnswering Questions in Issues etc.
๐Ÿ‘€ reviewReviewed Pull Requests
๐Ÿ›ก๏ธ securitySecurityIdentify and/or reduce security threats, Privacy, etc
โš ๏ธ testTestsPeople that have created tests
โœ… tutorialTutorialscontent creators that have made tutorials on this wrapper
๐Ÿ““ userTestingUser TestingPeople that have found an issue via testing
0.0.7

3 years ago

0.0.5

3 years ago

0.0.6

3 years ago

0.0.4

3 years ago

0.0.3

3 years ago

0.0.2

3 years ago

0.0.1

3 years ago