/Harvey

Community managment Discord bot for the Old Dominion University Computer Science community.

Primary LanguageJavaScript

Harvey

Harvey is a community managment Discord bot for the Old Dominion University Computer Science community.

Quick Start

To get started with Harvey you first must decide how you intend on hosting him.

System Requirments

  • NodeJS 18+
  • NPM

Docker (Recommended)

Note: You will need to install Docker or (if you are on Windows/Mac) Docker Desktop to use this method.

Open your command line and run these commands to get started:

docker pull ...
docker run ...

Regular Method

  1. Clone the repository to your computer.
git clone https://github.com/joeldesante/Harvey.git
  1. Access the directory and install the dependancies.
cd ./Harvey && npm install
  1. Create the configuration file and update it so it is valid.
cat ./.env.example > .env

After running the above command, you must open the .env file in a text editor and put your Discord bots token in the DISCORD_TOKEN field.

  1. (Optional) Setup the database.

More details about that to come...

  1. Install npm modules
npm install
  1. Start the bot.
npm start

Core Project Maintainers (Credits)

Joel DeSante https://desante.dev

William Faircloth https://willuhmjs.com/