Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shipgirlproject/haruna
A RESTful API around Topgg (Discord Bot List) voting webhooks
https://github.com/shipgirlproject/haruna
dbl dbl-vote-webhook discord discord-bot-list discordbot discordbotlist discordbotlist-webhook haruna topgg
Last synced: about 8 hours ago
JSON representation
A RESTful API around Topgg (Discord Bot List) voting webhooks
- Host: GitHub
- URL: https://github.com/shipgirlproject/haruna
- Owner: shipgirlproject
- License: apache-2.0
- Created: 2019-02-12T12:53:43.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-16T13:46:07.000Z (3 months ago)
- Last Synced: 2024-08-16T15:09:55.342Z (3 months ago)
- Topics: dbl, dbl-vote-webhook, discord, discord-bot-list, discordbot, discordbotlist, discordbotlist-webhook, haruna, topgg
- Language: Java
- Homepage: https://top.gg/api/docs#webhooks
- Size: 3.64 MB
- Stars: 12
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Haruna
The ShipGirl Project; Haruna. `(c) Kancolle for Haruna.`
> Fast and reliable.
> Run and forget, Haruna can run with **99.9% uptime**.
> Rest based API for your easy vote checks **without opening a webserver** on your bot.
> Webhook based API is also available if you are someone who needs both the **API** and **Realtime** vote handling.
# Documentation
## Rest API
### `POST` /newVote
The endpoint that is exposed to Top.gg (Discord Bot List); Refer to the image below.
### `GET` /voteInfo
The endpoint which you can use to check for votes.
Headers:
```js
{
"authorization": "the authorization key you have set on Top.gg (Discord Bot List) webhook"
}
```
Query String: `user_id`
Returns: JSON string.
```js
// User Voted
{
"user": "23213512",
"timestamp": 432483204,
"isWeekend": true,
"timeLeft": 274013
}
// User Didn't Vote
{
"user": false
}
```
### `GET` /stats
Returns: Current status of server in JSON string.
## Webhook API [1.4.0 and later]
> If enabled, it will send a POST request containing the user who voted in the URL of your choice.
> For checking the request validity, you can check the authorization header as it will send the same **restAuth** you have set on your config
Returns: JSON string.
```js
{
"user": "389138132391230131031903",
"isWeekend": true
}
```
# Haruna's API Wrappers
[Java](https://github.com/Deivu/Haruna/tree/master/HarunaWrapper/java)
[Javascript](https://github.com/Deivu/Haruna/tree/master/HarunaWrapper/Javascript-Node.js)
[C#](https://github.com/Deivu/Haruna/tree/master/HarunaWrapper/CSharp-Dotnet)
> you can also create your own and PR if you want to contribute it.
# How to Host
## Manually
1. Download the latest `haruna.jar` from Github Releases. [Click me](https://github.com/Deivu/Haruna/releases)
2. Download `HarunaConfig.json` from github. [Click me](https://github.com/Deivu/Haruna/blob/master/config_example/HarunaConfig.json)
3. Configure `HarunaConfig.json` according to your liking and put it BESIDE haruna.jar
4. Start the server via `java -jar haruna.jar`
5. To verify Haruna is working, navigate to `http://localhost:port_you_specified/` or `http://your_server_ip:the_port_you_specified/`. [Example](http://it-snake.net:1101/)
## Docker
1. Get docker-compose file. [Click me](https://github.com/Deivu/Haruna/blob/master/config_example/docker-compose.yml)
2. Update values according to your needs (**ports** and **environment**)
3. Start the server via `docker compose up -d`
# Haruna's config file example & explanation.
```js
{
"restAuth": "weeb_handler",
"topggAuth": "JRIrjrqwrpURJQWOPRj_rfnQEUi_KRqop",
"webhook": "https://discordapp.com/api/webhooks/84293482482420424024802/sneaky_token_OWO",
"postWebhook": "localhost:6969",
"debug": true,
"port": 1024,
"threads": 8,
"userTimeout": 432000000
}
```
- `restAuth` **(REST_AUTH)** is the Discord Bot List Webhook Authorization.
- `topggAuth` **(TOPGG_AUTH)** is your token for Discord Bot List.
- `webhook` **(WEBHOOK)** is your Discord Webhook link (Optional)
- `postWebhook` **(POST_WEBHOOK)** is where Haruna will try to send a POST request of the user who voted [Refer Here](https://github.com/Deivu/Haruna#webhook-api-v140-and-later) (Optional)
- `debug` **(DEBUG)** is if you want to enable debug logs of Haruna (Optional, Default: false)
- `port` **(PORT)** is what port you want this server hosted (Optional, Default: 1024)
- `threads` **(THREADS)** is how many threads you want this server to have (Optional, Default: Your CPU Thread Count)
- `userTimeout` **(USER_TIMEOUT)** is how long the user will stay in database in ms (Optional, Default: 43200000)
*Between parenthesis is the key to set as environment variable in case you want to use this configuration way.*
# Support
**We provide support for usage of this API in our Official Server's #development-support forums which is [in HERE](https://discordapp.com/invite/FVqbtGu)**
> Made with ❤️ by @ichimakase