[](https://github.com/Code-Sorcerers/Pterom/issues)
[](https://discord.gg/kU25cFa9YR)
---
## ๐ 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](https://www.npmjs.com/package/axios).
---
## ๐ป Getting started with installation
First install pterom with your package manager.
```bash
npm i pterom
or
yarn add pterom
```
```ts
// 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](https://github.com/Code-Sorcerers/Pterom/blob/main/LICENSE)
---
## โจ Contributors
Thanks goes to these wonderful people:
[](#contributors-)
---
| Emoji/Type | Represents | Comments |
| :--------------------------: | :--------------------: | :----------------------------------------------------------------------------------: |
| ๐
`bug` | Bug reports | Links to issues reported by the user on this project |
| ๐ป
`code` | Code | Links to commits by the user on this project |
| ๐
`doc` | Documentation | Links to commits by the user on this project, Wiki, or other source of documentation |
| ๐ก
`example` | Examples | People that have created examples to help others |
| ๐ต
`financial` | Financial Support | People or orgs who provide financial support |
| ๐ค
`ideas` | Ideas & Planning | |
| ๐ง
`maintenance` | Maintenance | People who help in maintaining the repo |
| ๐งโ๐ซ
`mentoring` | Mentoring | People who mentor new contributors |
| ๐
`projectManagement` | Project Management | |
| ๐ฌ
`question` | Answering Questions | Answering Questions in Issues etc. |
| ๐
`review` | Reviewed Pull Requests | |
| ๐ก๏ธ
`security` | Security | Identify and/or reduce security threats, Privacy, etc |
| โ ๏ธ
`test` | Tests | People that have created tests |
| โ
`tutorial` | Tutorials | content creators that have made tutorials on this wrapper |
| ๐
`userTesting` | User Testing | People that have found an issue via testing |
