Skip to content

Commit e9c9018

Browse files
authored
Create README.md
1 parent 6d8571d commit e9c9018

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Guilded.JS Base Handler
2+
This repository contains a base handler bot for Guilded, using the Guilded.JS library. The bot already has an example command and is easily customizable to fit your needs.
3+
4+
## Prerequisites
5+
Before using this bot, you will need:
6+
* Node.js installed on your machine. You can download it from the [official website](https://nodejs.org/).
7+
* A Guilded bot token. You can learn how to get one by following the instructions in [this file](./HOW-TO-GET-BOT-TOKEN.md).
8+
9+
## Installation
10+
To use this handler, you need to follow these steps:
11+
12+
1. Clone this repository to your local machine using the command:
13+
```bash
14+
git clone https://github.com/MixDevCode/gjs-base-handler.git
15+
```
16+
17+
2. Install the required dependencies using the command:
18+
```bash
19+
npm install
20+
```
21+
22+
3. Create a `.env` file in the root of the project and configure the necessary environment variables. You can use the `.env.example` file as a reference.
23+
24+
4. Run the bot using the command:
25+
```bash
26+
node index.js
27+
```
28+
29+
5. Your bot should now be up and running on Guilded.
30+
31+
## Used Modules
32+
* `@discordjs/collection`: To store the commands in a collection and later search for them using a handler.
33+
* `dotenv`: To use environment variables and protect sensitive information.
34+
* `glob`: To get the list of command and event files.
35+
* `guilded.js`: To connect to the Guilded API and receive server information.
36+
37+
## Contributions
38+
Feel free to contribute to this project by opening a Pull Request. Any improvements or suggestions are welcome.
39+
40+
## License
41+
This project is licensed under the ISC License. See the LICENSE file.
42+

0 commit comments

Comments
 (0)