Skip to content

Latest commit

 

History

History
209 lines (154 loc) · 7.76 KB

README.md

File metadata and controls

209 lines (154 loc) · 7.76 KB

Contributors Forks Stargazers Issues


Trakteer.js

Unofficial trakteer client
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact
  7. Getting Blocked by Cloudflare?
  8. Legal

About The Project

Unofficial Trakteer Streaming API (Using websocket)

(back to top)

Built With

  • Typescript

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use Trakteer.js and how to install them.

  • npm
    npm install trakteerjs@latest

Usage

For examples, please refer to the Examples

(back to top)

Features

  • Public API
Features Implemented? How to use it
Quantity Given Yes .quantityGiven(email)
Support History Yes .supportHistory()
Current Balance Yes .currentBalance()
Transaction History Yes .transactionHistory()
  • Stream API
Features Implemented? How to use it
Live Donation Yes .on("donation", (donation) => {})
Leaderboard Yes .getLeaderboard()
Get Goal Yes .getGoal()
Get Supporter Yes .getSupporter()

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the APACHE 2.0 + DNH License. See LICENSE for more information.

(back to top)

Contact

BbayuGt - @BbayuGt - [email protected]

Discord - @bbayugt

Project Link: https://github.com/BbayuGt/Trakteer.js

(back to top)

Getting blocked by Cloudflare?

Some Server Provider may be blocked by Cloudflare, if you get blocked, please join the Official Trakteer Discord Server and open a ticket, trakteer moderator will help from there

Legal

Trakteer.js is NOT affiliated with, maintained, sponsored or endorsed by Trakteer or any of its affiliates. Use at your own risk!

(back to top)