Skip to content

booleans-oss/brainly

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ReDoc logo

Machine Learning Discord Bot

Build Status Coverage Status dependencies Status devDependencies Status npm License

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

Deploy to Github Customization services

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:

Deployment 🌱

1. Install the repo

Install using git:

git clone [email protected]: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