ziko3000 / ethdevchecker

EthDevChecker

EthDevChecker Discord Bot

_{Built with ❤︎ by Min Fam}

This bot provides information about the latest big Ethereum Foundation transaction. When there is a new big transaction, the message automatically is being sent to the channel.

📝 Table of Contents

• Getting Started
• Usage
• License

🏁 Getting Started

Prerequisites

To run this project, you'll need to have:

• Node.js (version 14.0.0 or newer)
• A Discord bot token, which you can get by creating a bot on the Discord Developer Portal
• Discord.js 14
• Typescript
• An environment variable file (.env) for your bot token

Installing(Windows)

1. Clone this repository:

   git clone https://github.com/ziko3000/EthDevChecker

2. Change into the cloned repository:

   cd your-repo-name

3. Install the dependencies:

   npm install

4. Create an .env file in the root of your project and insert your bot token:

   BOT_TOKEN=YourDiscordBotToken
   APPLICATION_ID=YourApplicationId
   ETHERSCAN_API_KEY=''

5. Run the bot:

   npm run start
   

Installing Nodemon on Linux

Nodemon is a utility that will monitor for any changes in your source and automatically restart your server, perfect for development. Follow these steps to install it on Linux:

1. To install Nodemon globally (available to all your Node.js projects), you can run:

   npm install -g nodemon

   If you're facing permission issues, you may need to prepend sudo:

   sudo npm install -g nodemon

That's it! You've successfully installed Nodemon on your Linux machine. Now, you can use the nodemon command to run your bot:

    nodemon src/index.ts

🎈 Usage

This bot supports the following Slash commands:

• /help: Get help about the bot and its commands.

📄 License

This project is licensed under the MIT License - see the LICENSE.md file for details.