Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sinkaroid/disgrowth
Visualize your discord bots growth into chartable web-app & statistics with ease
https://github.com/sinkaroid/disgrowth
chartjs discord-bot vue
Last synced: 4 months ago
JSON representation
Visualize your discord bots growth into chartable web-app & statistics with ease
- Host: GitHub
- URL: https://github.com/sinkaroid/disgrowth
- Owner: sinkaroid
- License: mit
- Created: 2022-06-28T03:30:09.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-01-17T17:19:38.000Z (about 2 years ago)
- Last Synced: 2024-10-10T20:09:00.443Z (4 months ago)
- Topics: chartjs, discord-bot, vue
- Language: Vue
- Homepage: https://graph.scathachbot.xyz
- Size: 93.8 KB
- Stars: 10
- Watchers: 3
- Forks: 0
- 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-visualization - Create your web visualization Discord bots growth and statistics with ease. (Vue)
README
[](https://github.com/sinkaroid/disgrow/actions/workflows/mocha.yml) [](https://disgrow.js.org)
## 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](https://www.npmjs.com/package/disgrow) 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)!
## Prerequisites
NOTE: Your bot must be listed on top.gg, because we will take advantage of top.gg to get the increments 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 and the graph will not accurate.
That's all! All you need just keep posting your bot stats, and you are good to go.
## Getting started
1. Read the prerequisites, make sure your bots is passed the test, and install: `npm install` / `yarn install`
2. Fill the `config` properties with your bot's id and adjust the whole configuration
```js
{
botId: "724047481561809007", // Your bot's ID
memCacheExpire: 60, // How long to keep the data in memory cache (in minutes)
animatedCounter: true, // Whether number data will show as animated counter
barChartColor: "", // Color of the bar chart
lineChartColor: "", // Color of the line chart
lineChartHourlyColor: "", // Color of the line chart for hourly data
lineChartVotesColor: "", // Color of the line chart for votes
showPresentData: true, // Whether to show the present day's data or not
showPredictsData: true, // Whether to show the predicted data or not
switchTheme: true, // Switch dark to light themes, and otherwise
topggExternalButton: true, // Show the external of bot pages
alertOnFetch: false, // Alert when API is called, then memCache was expired
}
```
3. Test the unit first by running `npm run test:mocha`, You should get passing test like:
```
Check the prerequisites
Get the bots increments
✔ data should appear in the topgg
✔ data should have a key called 'title'
✔ data should have a key called 'total_votes'
✔ data should have a key called 'server_count'
✔ data should have property 'average_server_growth_daily' with value of type number
✔ data should have property 'average_server_growth_monthly' with value of type number
✔ data should have property 'approximate_credits_rewards_monthly' with value of type string
✔ data should have property 'approximate_server_growth_annually' with value of type number
8 passing (3s)
```
> If there is an error, means does not meet the requirements. Make sure follow the [#prerequisites](#prerequisites).
4. Run `npm run serve` to start the server, for building files run `npm run build`
## For production ready
The final steps is deploying the stuff, after you have test it all, Simply you can using this [template](https://github.com/sinkaroid/disgrow-visualization/generate), and fill the `config.js` with your bot's id and read the [Vuejs deployment guide](https://cli.vuejs.org/guide/deployment.html)
- [Github pages](https://cli.vuejs.org/guide/deployment.html#github-pages)
- [Netlify](https://cli.vuejs.org/guide/deployment.html#netlify)
- [Vercel](https://cli.vuejs.org/guide/deployment.html#vercel)
- [Firebase](https://cli.vuejs.org/guide/deployment.html#firebase)
## Acknowledgements
I hope you have found this project useful. All the major credit really goes to the [Topgg](https://top.gg/) and [Dblstatistics](https://dblstatistics.com/) for actionable data, [Vuejs](https://vuejs.org) and [Chart.js](https://www.chartjs.org/) which allow this services to be used.
## 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.