Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 1.52 KB

README.md

File metadata and controls

35 lines (24 loc) · 1.52 KB
Raw

HAL profile picture

HAL Discord Bot

codecov circleci

A discord bot made for the Unofficial RIT Discord Server. Has moderation capabilities along with some other miscellaneous uses.

Currently hosted on Heroku

How to run HAL

  1. Pull the code down via git clone [email protected]:Chris-Bitler/RIT-HAL.git
  2. Replace the discord_token and rapidapi_token in .env.bk with API tokens from the respective services.
  3. Set the postgres host and credentials and database in the .env.bk
  4. Move .env.bk to .env
  5. Run npm install in the project directory
  6. Run tsc to build the typescript code
  7. Run the bot via npm run hal

Filling in .env

The environment file includes 6 different environment variables that need to be filled out for HAL to work correctly. They are as follows:

discord_token: The bot token you obtain from a created bot at https://discord.com/developers/

rapidapi_token: Register for an account at https://rapidapi.com and obtain a key for https://rapidapi.com/transloc/api/openapi-1-2

sentry_dsn: The url for logging to sentry

DATABASE_URL: Database connection in url format