WidgetBot
WidgetBot is a pixel-perfect open-source Discord chat widget for your website. It is distributed and developed under the GNU General Public License v3 (GPL-3) Open Source License.
Development
The official Widgetbot team uses Visual Studio Code for developing Widgetbot.
This fork uses the IntelliJ IDEA Ultimate which is the paid version. The free one, Community Edition, doesn't support web development. You also have to install the NodeJS plugin.
You can use either, or something else.
Building Embed & Server
Before you are able to build anything make sure you have yarn
installed:
npm install -g yarn
If you're a macOS or Linux user, or if you're on Windows with the Git shell installed, you can build all packages at once like this:
yarn build
If you want to build them manually or use Windows without Git shell:
yarn
yarn workspace @widgetbot/embed-api build
yarn workspace @widgetbot/react-embed build
yarn workspace @widgetbot/html-embed build # you can skip this one if you don't need it
yarn workspace embed build
yarn workspace @widgetbot/crate build
yarn workspace server build
Then run the server:
yarn workspace server start
- You can find the embed running at http://localhost:7000/channels/YOUR-SERVER-ID.
- Invite your Bot to your Discord server using http://localhost:7000/api/invite.
Packages
@widgetbot/ | Description | ||
---|---|---|---|
embed | ReactJS widget client | Docs | /packages/embed/ |
crate | JS library that provides popup chat | Docs | /packages/crate/ |
react-embed | React component for the embed | Docs | /packages/react-embed/ |
html-embed | HTML element for the embed | Docs | /packages/html-embed/ |
embed-api | Embed GraphQL JS API | Docs | /packages/embed-api/ |
Contributors
Thanks goes to these wonderful people (emoji key):
Sam Denty |
---|
This project follows the all-contributors specification. Contributions of any kind welcome!