Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 1.37 KB

README.md

File metadata and controls

37 lines (25 loc) · 1.37 KB
Raw

ProgBot

ProgBot is a Discord bot designed specifically for the Programmers' Society Discord server. It is written in TypeScript using the NestJS framework and the Necord library built on the Discord.js library.

Hosting

ProgBot is currently able to be hosted through the docker image provided in this repository and the docker-compose file which includes addon services used to run the bot.

This includes:

  • Redis for caching
  • PostgreSQL for the database
  • MeiliSearch for the search engine

Planned Features

  • Reputation system
  • Member Verification
  • Docs Search

Contributing

This project is open to contributions and if you are interested in doing so please contact us on the Discord server.

Debugging

To get a local instance of the bot running:

  1. Create a Discord bot for testing from the Discord developer portal.
  2. Create a .env file from the .env.example file and fill out each field following the instructions in the file.
  3. Start the adjacent services using docker-compose up --build or, use the provided VSCode devcontainer.
  4. Install the Node dependencies and run the dev script with pnpm (e.g. pnpm install and pnpm run dev).

Requirements:

  • Docker
  • Docker Compose
  • Node.js
  • pnpm