Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sinkaroid/disgrow

A growth increments for your Discord bots
https://github.com/sinkaroid/disgrow

Last synced: about 2 months ago
JSON representation

A growth increments for your Discord bots

Host: GitHub
URL: https://github.com/sinkaroid/disgrow
Owner: sinkaroid
License: mit
Created: 2022-06-28T23:29:16.000Z (about 2 years ago)
Default Branch: master
Last Pushed: 2023-01-17T17:17:58.000Z (over 1 year ago)
Last Synced: 2024-05-01T18:12:11.906Z (5 months ago)
Language: TypeScript
Homepage: https://disgrow.js.org
Size: 209 KB
Stars: 3
Watchers: 2
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

awesome-indo-projects - Disgrow - A growth increments for your Discord bots. (JavaScript)
awesome-indonesia-repo - Disgrow - A growth increments for your Discord bots. (JavaScript)

README

A growth increments for your Discord bots

disgrow is a module for Discord bots. It allows you to check your bot's growth statistics,
Update hourly, and the hope that it will be reusable for every bot developers.
[The prerequisites](#Prerequisites) should be met before using this library.

Contributing •
Documentation •
Report Issues

---

- [disgrow](#)
- [Subprojects](#Subprojects)
- [Web-api for disgrow](https://github.com/sinkaroid/disgrow/tree/api)
- [Web-visualization of disgrow](https://github.com/sinkaroid/disgrow-visualization)
- [The problem](#the-problem)
- [The solution](#the-solution)
- [Features](#features)
- [Installation](#Installation)
- [Prerequisites](#Prerequisites)
- [Posting bot stats](#Prerequisites)
- [Documentation](#Documentation)
- [Example](#Example)
- [The returns](#The-returns)
- [Limitations](#limitations)
- [Acknowledgements](https://github.com/sinkaroid/disgrow/blob/master/ACKNOWLEDGEMENTS.md)
- [Legal](#legal)
- [For non JavaScript libraries](https://github.com/sinkaroid/disgrow/tree/api)

## The problem
There is a plenty monitoring and observability service for cloud-scale application, such as StatsD, DataDog, Prometheus, and etc. Those services are great for monitoring, but require a lot of effort to posts every parts and setup properly, many people probably still confused how to extends their discord bots with those services. Apart from complexity, the services is running, means It will consume extra Memory than usual, especially DataDog.

## The solution
There is a simple way to monitor your bot's growth. This library allows you to check your bot's growth statistics, no need posts any data, no need to extends or change your bot constructor, out of the box and less of pain.

For non JavaScript libraries, [there is an API for it](https://github.com/sinkaroid/disgrow/tree/api)!

## Features
Don't expect more with zero configuration, the point is it can give you actionable data related your bots increments.

- Summary stats daily and hourly
- Average increments
- Approximate increments
- Compare with other bots
- Expect even more features in the future..

NOTE: This module just give you an actionable data. If you really want to build a real monitoring service with a bar chart, fancy graph or anything, use real analytics and interactive visualization web apps

## 🚀Installation
`yarn add disgrow` / `npm i disgrow`

## Prerequisites

NOTE: NodeJS 14.x or higher

> Your bot must be listed on [top.gg](https://top.gg), because this module consume top.gg data, and You must **Posting bot stats** at least once per hour, there is a `stats_hourly` property in this module, otherwise null as it misleading.

## Documentation
The documentation can be found [https://sinkaroid.github.io/disgrow](https://sinkaroid.github.io/disgrow)
### Example
```js
import Disgrow from "disgrow";

const bot = new Disgrow("724047481561809007");
bot.myStats().then((res) => { console.log("myStats", res); });
```
> CommonJS should do with `const Disgrow = require("disgrow");`

### The returns
- `res.data`: object
- The bot's information
- `res.data.stats_daily` : object
- List of daily stats in the last 25 days
- `res.data.stats_hourly` : object
- List of hourly stats in the last 25 hours
- `res.average_server_growth_hourly` : number
- Average server growth hourly
- `res.average_server_growth_daily` : number
- Average server growth daily
- `res.average_server_growth_monthly` : number
- Average server growth monthly
- `res.average_votes_growth_monthly` : number
- Average votes growth monthly on top.gg
- `res.approximate_credits_rewards_monthly` : string
- Approximate [credits rewards](https://support.top.gg/support/solutions/articles/73000528198-using-your-vote-credit#:~:text=What%20are%20Vote%20Credits%3F,vote%20credit%20as%20a%20reward.) on top.gg
- `res.approximate_server_growth_three_months` : number
- Approximate server growth after 3 months
- `res.approximate_server_growth_annually` : number
- Approximate server growth after 1 year
```js
{
"data":{
"title":"Scathach",
"server_count":17997,
"shard_count":2,
"monthly_votes":5587,
"total_votes":31927
},
"stats_daily":[
{
"date":"June 25, 2022",
"total_server":17997,
"total_votes":31927,
"server_growth":"+76",
"votes_growth":"+432"
},
{
"date":"June 24, 2022",
"total_server":17921,
"total_votes":31495,
"server_growth":"+154",
"votes_growth":"+687"
},
{
"date":"",
"total_server":"0",
"total_votes":null,
"server_growth":"0",
"votes_growth":"0"
},
{
"date":"June 22, 2022",
"total_server":17767,
"total_votes":30808,
"server_growth":"+97",
"votes_growth":"+251"
},
{
"date":"June 21, 2022",
"total_server":17670,
"total_votes":30557,
"server_growth":"+109",
"votes_growth":"+259"
}
], // 25 items
"stats_hourly":[
{
"date":"Jun, 25 24:00",
"total_server":17997,
"server_growth":"+4"
},
{
"date":"Jun, 25 23:00",
"total_server":17993,
"server_growth":"0"
},
{
"date":"Jun, 25 22:00",
"total_server":17993,
"server_growth":"+4"
},
{
"date":"Jun, 25 21:00",
"total_server":17989,
"server_growth":"+7"
},
{
"date":"Jun, 25 20:00",
"total_server":17982,
"server_growth":"-1"
}
], // 25 items
"average_server_growth_hourly":3,
"average_server_growth_daily":66,
"average_server_growth_monthly":1654,
"average_votes_growth_monthly":5586,
"approximate_credits_rewards_monthly":"20.485 USD",
"approximate_server_growth_three_months":6006,
"approximate_server_growth_annually":24090
}
```

## Limitations
- `stats_daily` and `stats_hourly` are limited to 25 items, If you want to save them all in every months You should save them in somewhere else, like database.

## Legal
This tool can be freely copied, modified, altered, distributed without any attribution whatsoever. However, if you feel
like this tool deserves an attribution, mention it. It won't hurt anybody