Skip to content

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.

License

Notifications You must be signed in to change notification settings

Itz-Hyperz/firewallgg

Repository files navigation

FirewallGG

All 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 will be more your style. If none of these suit your needs, you can always just use our REST API here.

So again, your options are:

Step Two - Use / Integrate

For the basics, using the Website or the Desktop Process 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.

Yet, if you are entirely on your own, feel free to reference our public documentation for our Node Module here or for our Web API you can look here.

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:

[
    {
        "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.

{
  "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 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):

Itz-Hyperz
Itz-Hyperz

🐛 💼 💻 📖 🛡️ 👀
XolifyDev
XolifyDev

🤔 🔧
sandwichthedev
sandwichthedev

🤔 🔧 🐛
ZED Official
ZED Official

🤔 🔧
LouDawg
LouDawg

🔧 🤔
Shawn E.
Shawn E.

🎨 🤔
Jordan.#2139
Jordan.#2139

🤔 🔧 🚇
Nova Customs Inc
Nova Customs Inc

🔧 🤔
FusionsWorld
FusionsWorld

🤔 🔧
Patrick Calcote
Patrick Calcote

🤔 🔧
GregoryDev
GregoryDev

🤔 🔧
Plactrix
Plactrix

🤔 🔧
Hunter Fleming
Hunter Fleming

🤔 🔧
Adren
Adren

🤔 🔧
codenationgroup
codenationgroup

🤔 🔧
Paradise Solutions
Paradise Solutions

🤔 🔧

This project follows the all-contributors specification. Contributions of any kind welcome!

About

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.

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project