abheekd
/
awesomescibo
mirror of https://github.com/ADawesomeguy/AwesomeSciBo
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
399 Commits
6 Branches
34 Tags
2.4 MiB
 
 
 
Tree: 761371fccb
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '761371fccb'
${ noResults }
Abheek Dhawan 761371fccb
feat: remove WIP message in top command 		2 years ago
.github Adhere to TS and Markdown Style Guidelines (#46) 2 years ago
src feat: remove WIP message in top command 2 years ago
.dockerignore Add dockerignore for clean Docker builds 3 years ago
.eslintrc.json Adhere to TS and Markdown Style Guidelines (#46) 2 years ago
.gitattributes Add Git attributes file 3 years ago
.gitignore chore(gitignore): add .idea to ignore list 2 years ago
Dockerfile Update Dockerfile and docker-compose for TypeScript 3 years ago
LICENSE Convert to MIT license 3 years ago
README.md Adhere to TS and Markdown Style Guidelines (#46) 2 years ago
docker-compose.yml Adhere to TS and Markdown Style Guidelines (#46) 2 years ago
package.json Adhere to TS and Markdown Style Guidelines (#46) 2 years ago
tsconfig.json Adhere to TS and Markdown Style Guidelines (#46) 2 years ago
yarn.lock chore(deps): upgrade packages 2 years ago

README.md

logo

AwesomeSciBo

Open-source Discord bot that aims to aid up-and-coming Scibowlers with randomly generated (non-stock) rounds and training. It has many features, including subject-targeted training, a cross-server leaderboard, and a plethora of slash commands!

Deployment

Deploying this bot to your Discord server is relatively simple: you can add it to your own server by using this link.

Contributing

Please see CONTRIBUTING.md.

Installation

There are basically two ways to install it:

Method 1 (Node):

After cloning the repository, dependencies can be installed with yarn or npm i. The bot can then be compile to JavaScript with yarn tsc or npx tsc, and will be deployed in the built/ directory. Finally, the bot can be run by entering said directory and running ./index.js or node index.js.

Method 2 (Docker):

This bot has a Dockerfile within the repository which can be built using docker build . -t [tag]. Alternatively and preferably, the image can be taken from DockerHub.

Usage

This bot uses slash commands now :). You can just click on the bot icon after typing / to see a list of commands.

Credit

The bot was made by @ADawesomeguy. However, the API was made by @CQCumbers. Go give his API a star, he totally deserves it!