---

Table of Contents

• Overview
• Basic Setup Instructions
  • Git Instructions
    • Configuring Git
    • Cloning the Repository
  • Server Instructions
    • Installing the Bot
    • Configuring the Bot
    • Running the Bot
• Contributors

---

Overview

This repository houses the Simplicity Discord bot on the master version of the DiscordJS Library.

Basic Setup Instructions

This information will be relevant to users who are unfamiliar with standard Git and or Bot Practices and setup. Should you run into any issues, ask the current team, or if they are unsure, ask the latest team of Contributors.

Git Instructions

Configuring Git

• git config user.name "Name"
• git config user.email "your@email.com"

Cloning the Repository

• git clone https://github.com/Simplicity/Simplicity.git
• cd Simplicity

Server Instructions

Installing the Bot

• Install NVM
  • Windows: curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.34.0/install.sh | bash
  • Linux: curl https://raw.githubusercontent.com/creationix/nvm/v0.25.0/install.sh | bash
• git clone https://github.com/Simplicity/Simplicity.git
• cd Simplicity
• nvm install 12.4.0
• nvm use 12.4.0
• Install Yarn
  • Windows:
    • Install Chocolatey: installation guide
    • choco install yarn --ignore-dependencies
  • Linux:
    • curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
    • echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
    • sudo apt update && sudo apt install --no-install-recommends yarn
• yarn install

Configuring the Bot

• Copy the .env.example file and rename it into .env
  • Windows: copy .env.example .env
  • Linux: cp .env.example .env
• Open the .env file and insert the appropriate credentials

Running the Bot

• yarn start

---

Contributors

Almeeida - Tsugami