True Bot

Introduction   License and COC   Project structure   Getting started   Help & Support  

Just a quick introduction about us and the project

We're a small team of students and developers who want to make Discord a better place with the new technologies. During the Covid-19 Pandemic Emergency, we've started working on a project that could help students, teachers, workers, employees and employers to interact in the easiest way possible with the Discord platform. After making some online researches, we found that the most common programming languages, like Python JavaScript, Go etc... provide some interesting APIs that perfectly work with Discord.

Contribute to the project

In order to contribute and modify True's source code, the user must respect the:

1. Project Code of Conduct
2. Terms defined in the License

Our goal is to keep the community safe, open and above all free. To make this happen, we invite all users to stick to these simple but basic rules.

Bad behaviors

If a user becomes aware of acts that conflict with the code of conduct or license, kindly invite the user to make a report to the following email address: opensource@truebot.xyz providing, where possible, as much detail as possible on the matter. If necessary, contact the responsible person directly at salamatteojob@gmail.com.
For more information, please refer to the Code of Conduct.

Project structure

All the code is organised in the src folder, that contains all the folders for the commands and the functionalities of the bot.

Subfolders

Under the src directory, there are 2 folder:

1. commands: contains all the subfolders with the commands of the bot.
2. models: contains the model for the database collections.
3. errors: contains the files for handling the bot's errors

Getting started working on True Bot

❗ATTENTION: All thew project has been built using the WOK Commands library. Before doing anything else, please read the Official documentation for the library.

1. First of all you need to download the source. Fork and clone the repository.

git clone https://github.com/True-Team/True-Bot.git
cd ./True-Bot/src/

2. Download all the dependencies and start working on the project

npm ci
npm run dev

3. Start a pull request with your changes!

🧡Contribute to the project

We sincerely thank every user who enters and becomes part of our community and who will make his own contribution to ensure the sustainability of the project in all its parts.
If you want to support the project even more, you can make donations to the following page. The funds raised from donations will be invested for the improvement of the hosting platform, for the guarantee of greater security, protection and privacy and for the expenses of sustaining the domain.

🧡Thanks to everyone
From Sal Code and the Team