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.
330 Commits
6 Branches
34 Tags
2.4 MiB
 
 
 
Tree: b73a46183c
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'b73a46183c'
${ noResults }
Abheek Dhawan b73a46183c
Move guidelines to .github subdirectory 		3 years ago
.github Move guidelines to .github subdirectory 3 years ago
src Remove override button after usage 3 years ago
.dockerignore Add dockerignore for clean Docker builds 3 years ago
.eslintrc.json Change warn to error for arrow spacing 3 years ago
.gitignore Begin TypeScript migration 3 years ago
Dockerfile Update Dockerfile and docker-compose for TypeScript 3 years ago
LICENSE Convert to MIT license 3 years ago
README.md Rewrite README.md with updates 3 years ago
docker-compose.yml Fix docker-compose.yml and add npmjs release as a workflow 3 years ago
package.json Update scripts for TS in package.json 3 years ago
tsconfig.json Allow incremental compilation 3 years ago
yarn.lock Fix reimplement ESLint for TS and fix errors 3 years ago

README.md

out

AwesomeSciBo

A simple Discord bot that automatically generates Science Bowl rounds using the ScibowlDB API!

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!