Skip to content

Latest commit

 

History

History
96 lines (65 loc) · 4.2 KB

README.md

File metadata and controls

96 lines (65 loc) · 4.2 KB
Raw

UGLY BOT

uglyBee

This is a simple discord bot buit to interact with some discord users.

forthebadge forthebadge

Built using

Node Typescript Pulumi AWS

Test coverage

Architecture

Architecture

Prerequisites

Configuration

You need to create an environment config in the following way.

DISCORD_TOKEN='yourDiscordToken'
DISCORD_PUBLIC_KEY='yourDiscordPublickey'
DISCORD_APPLICATION_ID='yourDiscordApplicationId'
DISCORD_SERVER_ID='yourDiscordServerId'

And save it as any or all of the following files within the folder /environmentConfigs

develop.env
production.env
lambdadevelop.env

Your default environment is develop.env and default deployed environment would be lambdadevelop.env

Running it locally.

  1. Clone this repo using SSH or Github Cli (guide).
  2. Navigate to the cloned repo/folder(uglyBot) using a terminal or shell and run the following.
  3. npm install
  4. npm run build
  5. npm run start

Deploying and running it

  1. cd pulumi
  2. npm install
  3. pulumi up
  4. Review and accept the deployment. (note that this will automatically create required services and resources in AWS lambda).
  5. Copy the URL on the output apiGatewayEndpointUrl and append it with discordEvents. Example: https://example.execute-api.us-east-1.amazonaws.com/stage/discordEvents and set the INTERACTIONS ENDPOINT URL on your application to the URL you just constructed.
  6. Add your discord bot to one of your servers. (make sure the server ID is the same as the one you specified on Configuration).
  7. Try the command /info on your server.

Test coverage report generation

npm run coverage

Update readme with latest coverage

npm run updateReadmeCoverage

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Project Owner - Dasith Kuruppu