Machine Learning Discord Bot

This is README for v1.0.0-alpha version of this bot (@discord.js based).

Features 🛠

• Rock Paper Scissors
• Instant learning
• Easy to train
• Easy to customize (see Brain.js doc)
• Understandable

Roadmap 🏁

• optimization
• ReadME Update
• [] Full translation
• [] More commands
• [] Effecient logs

Releases 🔴

Important: this version 1.0.0-alpha is the first version. As time goes by, further releases would be done. Branches would be created to separate the releases:

• releases: https://github.com/booleans-oss/brainly/releases

• 2.0.x, e.g. v2.0.0-beta.15: https://github.com/booleans-oss/brainly/releases/tag/1.0.0

• next release: https://github.com/booleans-oss/brainly/releases/tag/1.0.0/next

Deployment 🌱

1. Install the repo

Install using git:

git clone git@github.com:booleans-oss/brainly.git

2. Depedencies installation

Install using npm:

npm i

or using yarn;

4. Update .env example

Change the .env example with the your information.

4. Starting the project

Using internal implemented script

npm run start

or using node;

node src/index.js

5. Train your machine 😄

Configuration 💡

There isn't any configuration to do. The credentials need to be done on your side. Config and Token files are not provided in this repository.

---

Development

see CONTRIBUTING.md