Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonaskroedel/bananacore
https://github.com/jonaskroedel/bananacore
Last synced: 10 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/jonaskroedel/bananacore
- Owner: jonaskroedel
- License: gpl-3.0
- Created: 2024-02-21T18:22:01.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-03-05T12:06:52.000Z (9 months ago)
- Last Synced: 2024-03-05T13:28:45.745Z (9 months ago)
- Language: JavaScript
- Size: 354 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
BananaCORE Framework
A Discord bot Framework made with discord.js
The banana [bəˈnænə] is a long, curved fruit with a soft, sweet flesh covered by a yellow peel when ripe. It grows in clusters and is rich in nutrients.
Ba·na·naCORE [the]: A highly customizable Discord bot framework
## About
BananaCORE is an open source, highly customizable Discord bot framework. The framework comes packaged with a variety of sample commands. BananaCORE serves as a a base framework so everyone can easily create a Discord Bot of all kinds and needs. Also, you can join my Server [Funf](https://discord.gg/EejzQcpMHG) for questions, suggestions, assistance and much more.
If you like this repository, feel free to leave a star ⭐ to help promote BananaCORE!
## Why BananaCORE?
I don't know, just use it ;)
## Features
Currently, none. But I plan to add a lot of features in the future.
## Installation
````
git clone https://github.com/jonaskroedel/bananacore
````
After cloning, run these commands
````
npm install
````
to get all the dependencies and packages. You need [Node.js](https://nodejs.org/), [MySQL](https://www.mysql.com/) and [MongoDB](https://www.mongodb.com/) installed. I highly recommend to install [nodemon](https://www.npmjs.com/package/nodemon) as it makes testing *much* easier.
## Setting Up
You have to create a ``.env`` file in your root directory to run the bot (you can use the example file provided as a base). Your file should look something like this:
````
DISCORD_TOKEN=YOUR_DISCORD_TOKEN
MONGODB_URI=YOUR_MONGODB_URI
````
Visit the Discord [developer portal](https://discordapp.com/developers/applications/) to create an app and use the client token you are given for the `token` option. `ownerId` is your own Discord snowflake.
After that, you have enable `Privileged Intents` on your Discord [developer portal](https://discordapp.com/developers/applications/). You can find these intents under the "Bot" section, and there are two ticks you have to switch on. For more information on Gateway Intents, check out [this](https://discordjs.guide/popular-topics/intents.html#the-intents-bit-field-wrapper) link.
## To-Do
BananaCORE is in a very early stage of development. Here are some of the things I plan to add:
- Preview commands
- WebInterface
## License
Released under the [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.en.html) license.
## Credits
- **Jonas Krödel** - *initial work, artwork, idea, implementation and project management* - [github](https://github.com/jonaskroedel)
© Jonas Krödel 2024