D2-Vendor-Alert

Follow these simple steps to add D2-Vendor-Alert to your Discord server:

1. Vist this URL to authorize the bot on your Discord server.
2. Run the /alert slash command from the Discord server the bot was authorized for. The command can be executed by typing "/alert".
3. Follow the prompts!

Contributing

Create a pull request against the main branch and if it passes through the GitHub Action pipeline and a cursory look, I'll ensure it gets merged in.

Development

• Install Node version 19, use this doc for help if needed
• Clone repo
• Use the ".example.env" file as a template for an actual ".env" file, located at the root of the project.
  • The example file lists out every required property needed for local development, albeit the "MONGO_URI" and "DATABASE_..." properties.
  • The "MONGO_URI" and "DATABASE_..." properties are mutually exclusive and should be treated as so, you must enter in values for either the "MONGO_URI" property or the set of "DATABASE_..." properties and then remove the other property(ies).
• While located at the root of the project in a terminal, run the npm install command
• You should be good to go! Run the npm run start command in a termainal from the root of the project and the bot will start up.

Documentation

Check out my doc site for this project!