Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pranshu05/elpha
An opensource discord.js bot
https://github.com/pranshu05/elpha
chatbot discord discord-bot discord-chat-bot discordbot discordjs elpha elphabot hacktoberfest hacktoberfest2024 modbot nodejs open-source
Last synced: 2 months ago
JSON representation
An opensource discord.js bot
- Host: GitHub
- URL: https://github.com/pranshu05/elpha
- Owner: pranshu05
- Created: 2021-12-03T17:42:19.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-08T12:10:20.000Z (3 months ago)
- Last Synced: 2024-10-21T15:04:39.464Z (2 months ago)
- Topics: chatbot, discord, discord-bot, discord-chat-bot, discordbot, discordjs, elpha, elphabot, hacktoberfest, hacktoberfest2024, modbot, nodejs, open-source
- Language: JavaScript
- Homepage: https://elphabot.github.io/
- Size: 4.13 MB
- Stars: 25
- Watchers: 2
- Forks: 19
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Elpha! The open-source discord bot
[](https://discord.gg/CVyx9qyYPF)
[](https://discord.com/oauth2/authorize?client_id=916613852362330133&permissions=8&scope=bot%20applications.commands)
# 🤖 What is Elpha?
### Elpha is an open source discord bot which developed from discord.js and based on slash commands. Contribute to this open-source repo to make the bot more powerful.
# Getting Started with SLoP4.0
## Before You Begin...
Creating a bot using [discord.js](https://discord.js.org/) requires a solid understanding of JavaScript. While it's possible to build a bot with minimal programming knowledge, not having a good grasp of JavaScript can lead to frustration when facing basic issues and problems. It's essential to learn the language first to avoid unnecessary obstacles.
For this project, we will be using [discord.js](https://discord.js.org/) as our primary library, and we will be referring to its comprehensive [documentation](https://discordjs.guide/) extensively.
To test and communicate with the community, please join the [Discord Server](https://discord.gg/N9DhCWk2yR). Once you've forked and cloned this repository, it's crucial to go through the following sections:
- **Installation and Preparations**: Get your development environment set up by following the steps outlined in [Installation and Preparations](https://discordjs.guide/preparations).
- **Creating Your Bot**: Learn how to create your Discord bot by following the guidelines in [Creating your bot](https://discordjs.guide/creating-your-bot). After creating your bot please send bot's **client id** in the [Discord Server](https://discord.gg/N9DhCWk2yR).
- **Slash Commands**: Understand how to implement Slash Commands, a powerful feature in Discord bots, by referring to [Slash Commands](https://discordjs.guide/slash-commands).
Please note that the [old branch](https://github.com/pranshu05/Elpha/tree/old) of this repository contains files of the bot created in discord.js v13. In SLoP3.0, we are migrating this bot to discord.js v14, so it's crucial to review the changes between the two versions. You can find a comprehensive list of these changes in [A list of the changes from discord.js v13 to v14](https://discordjs.guide/additional-info/changes-in-v14.html).
I am excited to have you on board for this project, and I believe this experience will be a valuable learning opportunity. If you have any questions or need assistance, feel free to reach out to me through our Discord Server.
## How to Install Packages?
To get started, ensure that you have Node.js and npm (Node Package Manager) installed on your system. Then, follow these steps:
1. Open your terminal or command prompt.
2. Navigate to the project directory where the bot's code is located.
3. Run the following command to install the necessary packages:
```sh
npm install
```
## How to Run the Bot?
To run the bot, use the following command:
```sh
npm start
```
## Development Setup
If you are developing the bot and want automatic code reloading during changes, you can use nodemon. Here's how to set it up:
Install `nodemon` globally by running:
```sh
npm install -g nodemon
```
Add a `dev` script to your package.json file, like this:
```json
"scripts": {
"start": "node src/bot.js",
"dev": "nodemon src/bot.js"
}
```
Now, you can run the bot in development mode using the following command:
```sh
npm run dev
```
This will automatically restart the bot whenever you make changes to the source code, making your development workflow more efficient.
## .env File
The `.env` file contains sensitive information such as tokens and API keys. It's crucial to keep this file secure and never share it with anyone. Here's how your .env file should be structured:
```plaintext
MONGO_URL=your_mongo_url_here
token=your_bot_token_here
tenor=your_tenor_api_key_here
```
Make sure to replace `your_mongo_url_here`, `your_bot_token_here`, and `your_tenor_api_key_here` with your actual credentials and keys.
**Adding .env to .gitignore:**
To ensure that your .env file is not accidentally committed to version control (e.g., Git), you should add it to your project's `.gitignore` file. If you don't have a `.gitignore` file yet, create one in the root of your project directory.
Here's how you can add `.env` to your `.gitignore` file:
1. Open or create your `.gitignore` file.
2. Add the following line to it:
```plaintext
.env
```
3. Save the `.gitignore` file.
By adding `.env` to your `.gitignore`, you ensure that this sensitive file is not tracked by Git and remains private. Protecting your credentials and API keys is essential for the security of your application.
---
### Happy coding and welcome to the world of Discord bot development! 🤖🚀
# 🤝 Contributors
# 📝 License
Copyright © 2023 [Pranshu Patel](https://github.com/pranshu05)
This project is [MIT](https://opensource.org/licenses/MIT) licensed.
---