Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bsovs/build-a-bot
Build-A-Bot is a Discord Bot starter using nodejs
https://github.com/bsovs/build-a-bot
discord discord-bot discord-js discordjs javascript node nodejs
Last synced: about 1 month ago
JSON representation
Build-A-Bot is a Discord Bot starter using nodejs
- Host: GitHub
- URL: https://github.com/bsovs/build-a-bot
- Owner: bsovs
- License: gpl-3.0
- Created: 2020-11-08T01:28:12.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2020-11-09T02:10:04.000Z (about 4 years ago)
- Last Synced: 2023-03-03T22:57:20.591Z (almost 2 years ago)
- Topics: discord, discord-bot, discord-js, discordjs, javascript, node, nodejs
- Language: JavaScript
- Homepage:
- Size: 83 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Build-A-Bot
*Starter kit to build a Discord Server Bot*
### Getting Started
Build-a-Bot requires [Node.js](https://nodejs.org/) v10+ to run.
Install the dependencies and devDependencies and start the server.
```sh
$ git clone https://github.com/bsovs/build-a-bot.git
$ cd build-a-bot
$ npm i
$ node server.js
```
### Launching Bot
```sh
$ node server
```
### Creating a new command
Run to create a new bot command (creates cmd, flag, and test files)
```sh
$ npm run new
```
### Testing
Run mocha tests in intellij or by running the following test command
```sh
$ npm run test
```
### [Documentation - *wip*](https://github.com/bsovs/build-a-bot/tree/master/src#docs---wip)
# Full Guide
### Step 1
> Create a new application at: \
> https://discord.com/developers/applications \
> [](https://discord.com/developers/applications)
### Step 2
> Add a bot to your new app \
> 
### Step 3
> Copy your bot token (should be in the General tab) and head over to \
> https://discord.com/oauth2/authorize?scope=bot&client_id=YOUR_CLIENT_ID \
>  \
> Should look something like this\
>  \
> Add your bot to your server
### Step 4
> Copy over your bot token to the config.json file \
>  \
>  \
> `./config.json`
### Step 5
> Test it out! \
> Launch using ```node server``` in command promt, then send `!ping` in discord \
>  \
> *Note: if you have node yet installed depandancies do so now using the following commands,
```sh
$ npm i
$ node server.js
```
### Step 6
> Customise a new command. \
> Use ``` npm run new ``` to create a new command. \
> Open up your new command *(found in ./src/bot/commands/)* \
> Once your command is registered you can refresh it by sending ```!refresh *your command*``` to discord.
### Hosting on Heroku
> In order to keep your bot running all the time we suggest using Heroku hosting solutions. \
> Head over to https://devcenter.heroku.com/articles/git and learn about how to deploy nodejs apps to Heroku \
> Add your config variables from ` config.json ` to your apps environment variables.