Guardian-bot

The Goal is to Protect

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Configuration - Discord Developer Portal
4. Roadmap
5. Contributing
6. License
7. Contributors

About The Project

A lot of phishing and spam urls are getting circulated on discord these days. Those who are falling for the so called free gifts are ending up compromising their accounts.
So I thought of making the Guardian-bot for our Discord Community.

Built With

• Typescript
• discord.js
• axios
• ipqualityscore.com

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

You should have Javascript and Typescript installed in your system. If not then don't worry the installation section has all the steps that you are going to need.

• Active internet connection through out installation (Must)
• Account in ipqualityscore.com (Must for Other Users)
• Javascript (Must for Other Users)
• Typescript (Must for Other Users)

Installation

For Windows users

1. Fork the project.
2. Clone the forked repository.

   git clone https://github.com/<your_username>/Guardian-bot.git

3. Move to the directory.

   cd Guardian-bot

4. Create a Bot from the Discord Developer Portal and copy the Bot token. Create a .env file in the root directory and paste the Token.

   TOKEN = "Your Token"

5. Create an account at ipqualityscore.com and go to Malicious URL Scanner API Documentation
6. Copy the API PRIVATE KEY and paste it in the .env file as:

   PRIV_KEY = "Your Private Key"

7. Copy the API URL and paste it in the .env file as:

   API_URL="API URL FOR IPQUALITYSCORE.COM"

8. Install Typescript and ts-node globally

   npm i -g typescript ts-node

9. Install all the packages

   npm i

10. Invite the Bot to your server and run

• To run in dev mode

  npm run dev

For Linux users

1. Fork the project.
2. Clone the forked repository.

   git clone https://github.com/<your_username>/Guardian-bot.git

3. Move to the directory.

   cd Guardian-bot/

4. Create a Bot from the Discord Developer Portal and copy the Bot token. Create a .env file in the root directory and paste the Token.

   TOKEN = "Your Token"

5. Create an account at ipqualityscore.com and go to Malicious URL Scanner API Documentation
6. Copy the API PRIVATE KEY and paste it in the .env file as:

   PRIV_KEY = "Your Private Key"

7. Copy the API URL and paste it in the .env file as:

   API_URL="API URL FOR IPQUALITYSCORE.COM"

8. Install Typescript and ts-node globally

   npm i -g typescript ts-node

9. Install all the packages

   npm i

10. Invite the Bot to your server and run

• To run in dev mode

  npm run dev

Configuration - Discord Developer Portal

Go to the Discord Developer Portal to create your application and bot. You must give the following permissions:

• Admin Intent ✔️

Roadmap

See the open issues for a list of proposed features (and known issues). Feel free to raise new issues.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch ( git checkout -b feature/AmazingFeature )
3. Add your Changes ( git add . )
4. Commit your Changes ( git commit -m 'Add some AmazingFeature' )
5. Push to the Branch ( git push -u origin feature/AmazingFeature )
6. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contributors

---

Saup21