Kaga is a discord bot created in Node.JS using the Akairo framework.
- Node.JS (and clearly NPM too)
- Akairo, the framework the bot is built on.
- StandardJS, the code style I use.
- PM2, a process manager for applications.
Well, as of right now, you can't. I spend a lot of time developing this bot to make it production ready and even at that, it still has bugs I find. As I try to add features as quickly as possible, I also encounter bugs at the same rate. I don't know how long it will take to fix all these bugs and add all the features I would like, but when I do, this bot will become public, and the repo license will probably change to reflect that.
I need a place to store this bot incase of any losses on my local end. It also helps with the organization of coding across multiple devices. Along with this, Kaga is free to use for your own server, or even to use for your own project. Please do give some credit to me somewhere in the project, though. The license is a thing and I have no issue taking copies of this repo down in accordance with it.
What you can do
- Commercially use this project
- Redistribute the code
- Make modifications to this code
What you have to do
- Make any source code public
- Include a copy of this repo's license (AGPL-3.0)
- State any changes in the code
Other stuff you should know
- Don't drag me into anything you do wrong
- No, there isn't a warranty
You're interested, I see. In accordance with the license, you can help me build this bot!
Clone the repo, either by downloading it or using the git command.
$ git clone https://github.com/minteeaa/kaga.git
$ cd kaga/
Please, make my life easier by using the StandardJS code style. It has installations for Atom, VSCode, Sublime Text, or whatever code editor you use. I have also added a dependency in the package for the StandardJS server to use incase addons aren't your thing. I do this to keep code clean, and if you don't stick to it, it will be up to me to clean any PRs and additions before adding them.
Navigate to the repository folder and fill out the .env.example file accordingly. (it's pretty empty as of now... but that will change.)
TOKEN=
OWNERID=
Rename the example file to .env.
$ rename ".env.example" ".env"
$ mv ".env.example" ".env"
Assuming your computer hasn't exploded yet, you can now run the bot. Go ahead and check out the kaga.config.js and edit it to your liking. You'll need to run this in PM2.
$ pm2 start kaga.config.js
To monitor the bot, you can leave the logs open...
$ pm2 logs
... or you can use the monit command.
$ pm2 monit
Kaga © mintea
Under the AGPL-3.0 License.
Made with ❤️ and a lot of coffee by mintea.
Github: minteeaa | Twitter: @minteaseu | Discord: mintea#0001