quicklink-bot

Description

A simple Discord bot that stores and returns URLs and text to a user's Discord channel

Inviting and Setting Up the Bot to your Server

• Click the oauth2 link underneath and select the server you wish to invite the bot to https://discordapp.com/oauth2/authorize?client_id=624364418737766410&scope=bot
• Run the command $mkcol to establish a database collection
• Use the bot to your will

Commands

Using the prefix '$':

• mkcol : initializes collection for the serverid, and is required to exist
• rmcol : deletes the serverid collection from database
• add [title] [text] : adds entry into the collection
• rm [title] : removes entry from collection
• ls [page number] : returns entries in blocks of 15
• grep [text] : returns entries that contain text
• sid : returns the server's id
• help : returns list of commmands

Dependencies

• node.js v.^10
• discord.js v.^11
• dotenv v.^8
• mongodb v.^3

Installation Process

• Install node.js latest stable release

• For macOS, check if node exists by running node -v

• If node does not exist :

  • Go to nodejs.org and download the latest version

• If node exists :

  • Update node by npm i -g npm or sudo npm i -g npm

• Create a dedicated project folder with mkdir 'project-name' and then cd into it

• Run npm init and ignore the package.json and questions if confused

• Run npm install discord.js

Running the Application

• Initially only ran locally with node index.js
• Currently hosted on heroku to run 24/7