Brief description of your project.
Before you begin, ensure you have met the following requirements:
- You have installed the latest version of Rust
- You have a Linux/Mac OS/Windows machine.
- You have installed PostgreSQL (or your preferred database supported by Diesel)
To install TTB, follow these steps:
- Clone the repository:
https://github.com/tolu-afo/TTB.git
- Install the Diesel CLI:
https://diesel.rs/guides/getting-started
- Set Up the database: echo DATABASE_URL=postgres://username:password@localhost/database_name > .env
- Run
diesel setup
- Run the migrations:
diesel migration run
To use Project Name, follow these steps:
- In the .env add the following environment variables:
BROADCASTER_ID
: The twitch id of the broadcaster/streamer whose chat you want the bot to connect toTWITCH_CLIENT_SECRET
: The client secret for your twitch app accountTWITCH_CLIENT_ID
: The client id for your twitch app accountBOT_OAUTH_TOKEN
: The oauth token for your bot accountBOT_USERNAME
: The username for your bot account- Run
cargo run
To contribute to TTB, follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b <branch_name>
. - Make your changes and commit them:
git commit -m '<commit_message>'
- Push to the original branch:
git push origin <project_name>/<location>
- Create the pull request.
Alternatively, see the GitHub documentation on creating a pull request.
Thanks to the following people who have contributed to this project:
If you want to contact me, you can reach me at tolu@asokpo.com.
This project uses the following license: MIT / Apache 2.0.