Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/itz-hyperz/firewallgg

A simple program that will search all users in multiple database api's to see if they are banned in any of them. It will return a list of all databases the user is banned in as-well.
https://github.com/itz-hyperz/firewallgg

application database discord node-module passport security

Last synced: 13 days ago
JSON representation

A simple program that will search all users in multiple database api's to see if they are banned in any of them. It will return a list of all databases the user is banned in as-well.

Host: GitHub
URL: https://github.com/itz-hyperz/firewallgg
Owner: Itz-Hyperz
License: other
Created: 2022-07-09T05:09:18.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-07-06T16:19:37.000Z (7 months ago)
Last Synced: 2025-01-01T21:09:42.180Z (20 days ago)
Topics: application, database, discord, node-module, passport, security
Language: EJS
Homepage: https://firewall.loganswebservices.com
Size: 476 KB
Stars: 41
Watchers: 1
Forks: 16
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

# FirewallGG

[![All Contributors](https://img.shields.io/badge/all_contributors-16-blue.svg)](#contributors)

FirewallGG is a *background-checking* tool. What it will allow you to do, is check a user's Discord Id and see if they are banned in any databases that are synced within the Firewall. This allows you to mass check databases with almost no hassle at all. Just a simple setup and you will be all good to go!

- Highlight Color: `#5865F2`
- Sections Color: `#172144`
- Background Color: `#060F27`

# How it works
FirewallGG is **both** *client sided* and *server sided*. What this means is users on any platform can now use FirewallGG to it's fullest capabilities. From a backend database background check on users, to a website for ease of access anywhere, all the way out to a desktop process that will allow you to run user Ids and get a return on them easily.

## Step One - Pick a method
First, you need to find out just which method will best suit your needs for using FirewallGG. If you're just trying to check a users background history, maybe just the website will be enough for you, but if you're looking for something a little more backend wise, possibly the [Node Module](https://npmjs.com/package/firewallgg) will be more your style. If none of these suit your needs, you can always just use our REST API [here](https://firewall.hyperz.world/api).

So again, your options are:
- The [Website](https://firewall.hyperz.world).
- The [Node Module](https://npmjs.com/package/firewallgg)
- The [Web API](https://firewall.hyperz.world/api).
- The [Desktop CliTool](https://github.com/Itz-Hyperz/firewallgg/releases)
- The [FiveM Resource](https://github.com/Itz-Hyperz/firewallgg/tree/main/examples/FirewallGG-FiveM)

## Step Two - Use / Integrate
For the basics, using the [Website](https://firewall.hyperz.world) or the [Desktop Process](https://github.com/Itz-Hyperz/firewallgg/releases) is pretty straight forward. Simply open one and enter a Discord User Id.

On the other hand, integrating it into your system may be a little bit more difficult. Most of our target audience uses FaxStore. So, if you're looking to easily integrate, look no-further than our built-in FaxStore extension that can be found [here](#input).

Yet, if you are entirely on your own, feel free to reference our public documentation for our Node Module [here](https://npmjs.com/package/firewallgg) or for our Web API you can look [here](https://firewall.hyperz.world/api).

## API Object Structure
This is where you can look to add your own database into the FirewallGG Middleware!

Below is what gets returned from our API upon making a request:
```json
[
{
"database": "DATABASE_NAME",
"themeColor": "DATABASE_THEME_COLOR",
"logoUrl": "DATABASE_LOGO_URL",
"appealLink": "DATABASE_APPEAL_LINK",
"active": true,
"userid": "BANNED_USER_ID",
"reason": "BANNED_USER_REASON",
"proof": "BANNED_USER_PROOF",
"time": "TIME_OF_BAN",
"otherData": {}
}
]
```

You need to build your database API endpoint to return a JSON object with these keys as the *only returning keys*.
```json
{
"active": yourObject.active,
"userid": yourObject.userid,
"reason": yourObject.reason,
"proof": yourObject.proof,
"time": yourObject.time
}
```

Upon creating a pull request to add to the [`databases.json`](https://github.com/Itz-Hyperz/firewallgg/blob/main/databases.json) file, you will *also* need to provide a screenshot of what *exactly* gets returned from that API endpoint on your end, this way developers can verify that these data types are correct with no excess-hassle.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

_Itz-Hyperz
🐛 💼 💻 📖 🛡️ 👀

_XolifyDev
🤔 🔧

_{sandwichthedev}
🤔 🔧 🐛

_{ZED Official}
🤔 🔧

_LouDawg
🔧 🤔

_{Shawn E.}
🎨 🤔

_Jordan.#2139
🤔 🔧 🚇

_{Nova Customs Inc}
🔧 🤔

_FusionsWorld
🤔 🔧

_{Patrick Calcote}
🤔 🔧

_GregoryDev
🤔 🔧

_Plactrix
🤔 🔧

_{Hunter Fleming}
🤔 🔧

_Adren
🤔 🔧

_{codenationgroup}
🤔 🔧

_{Paradise Solutions}
🤔 🔧