README.md

Mr.Plex

Coderplex Discord Chat bot, for life.

Requirements

• NodeJS & NPM/Yarn
• Typescript

Contributing guide

• First, fork the repository & clone it onto your local device

  git clone https://github.com/YOUR_USER_NAME/Mr.Plex && cd Mr.Plex

• Install required dependencies

  • with yarn

      yarn install

  • with npm

      npm install

• Meanwhile, Open Discord Developer Portal and create a new bot

• Copy the bot token and create a new file .env at the root of the project folder

• Add a new local env variable BOT_TOKEN into .env, example:

  BOT_TOKEN=YOUR_TOKEN_HERE

• Now you can start building the bot

  • with yarn

      yarn run build

  • with npm

      npm run build

• In a seperate terminal, you can start the bot

  • with yarn

      yarn run start

  • with npm

      npm run start

• Invite the bot to your personal discord server and start hacking!