This is the official discord bot of the Devil Quant Discord.
Clone the repository by running the following command
git clone https://github.com/DevilQuantASU/quantbot.git
Get the required libraries
Note: you are highly recommended to create a virtual environment for python
pip install -r requirements.txt
You need a discord application to run off of. You can create one at the following link: https://discord.com/developers/applications. Once you have done that copy the application token. Create a .env file in the root of the project and fill it as you see below.
TOKEN=your_token
You are all set to go now! Run the following command to get started:
python main.py
This section is coming soon...
Members of DevilQuant (ASU organization) are highly encouraged to contribute to quantbot. This repository is specifically designed to be accessible and easy to contribute to, as such it is an excellent opportunity to get familiar with open-source and version control work flows.
Choose an issue you would like to solve. If you do not have write access to the repository, first create a fork (skip this step if you do have write access). Then, create a branch with the following naming conventions, (identifier)-(feature-implemented). For example, for my identifier I can use, my username, 1nsomnes or my initials cc. And then for the feature it could be that I am rewriting the readme. So, an acceptable branch name would be 1nsomnes-rewriting-branch. Commit and push the changes you want to make. Create a pull request. Attach the relevant issue(s) and write a brief description of what you have done. Once a repository admin reviews and accepts it, it will be merged onto the main branch.
Have you noticed a feature that is missing with the discord bot? Start by creating an issue recommending the feature. Some discussion may occur over the practicality of the feature, and if you are interested in creating it follow the steps in the section above.