Awesome
Webdev Support Bot
<p align="center"> <img src="./logo.png" /> </p>Bot providing multiple commands to query common sites used during development or helping people on Discord.
Supports
!github
via GitHub API
,
!composer
via packagist API
,
!npm
via unofficial npmjs.com API
,
!mdn
via parsing Mozilla Developer Network,
!caniuse
via unofficial caniuse API
and @mdn/browser-combat-data,
!bundlephobia
via unofficial bundlephobia API
,
!jquery
as explanation on why not to use jquery,
!php
via parsing official PHP Docs.
Usage / TLDR
# tag it in discord to receive general help
@bot --help
# provides an example each
!mdn --help
!caniuse --help
!composer --help
!npm --help
!github --help
!bundlephobia --help
# queries MDN with <term>
!mdn <term>
# queries caniuse with <term>
!caniuse <term>
# queries packagist with <package>
!composer <package>
# queries npm with <package>
!npm <package>
# queries github with <term>
!github <term>
# queries bundlephobia with <term>
!bundlephobia <term>
- single-result queries will directly show the result
- reacting with a number will filter the result
- reacting with the red or black
x
will remove the request
Description
By default, shows the first ten results of any given query, unless only one result was found.
Reacting with a number corresponding to the list entry will filter the list and edit the original message, providing more specific information.
Add to your server by...
...accessing this link.
Demo
<p align="center"> <img src="./webdev-support-bot-demo.gif" /> </p>Development
git clone https://github.com/ljosberinn/webdev-support-bot/
cd webdev-support-bot
cp .env.example .env # and enter a token
yarn install # or npm install
code .
yarn dev # or npm dev
# or be fancy with a one-liner
git clone https://github.com/ljosberinn/webdev-support-bot/ && cd webdev-support-bot && cp .env.example .env && yarn install && code . && yarn dev
Environment variables
In development, you generally want to take the .env.example
and rename it to .env
. You also shouldn't commit your .env
file. If you make any changes to the environment variables, you should update .env.example
. accordingly.
Running tests:
$ npm test
Found a bug/want to contribute?
Please head over to GitHub.