Giter Club home page Giter Club logo

mermaidjs-discord's Introduction

mermaidjs-discord

mermaidjs-discord is a discord bot that allows you to render Mermaid.js diagrams in your discord chats.

Server Installation instructions

Click here to invite the bot to your server.

Type in !mermaid-help for help on how to use this bot.


Running this bot locally

Installation


This installation assumes you have python3 installed on your machine and know how to use pip.

Run the following in the project root directory to get all the dependencies

pip install poetry
poetry install

Bot Token


After we have that installed, we need to grab a bot token from Discord.

Go to this url and create a new application.
Add a name for your local bot, something like: your-username-test-bot.

After you've made an application, you should be redirected to a page with all of the app's details on it. Scroll to the bottom of this page and press "create a bot user". You will then have a "click to reveal" link that shows you your bot's token.

Run the following in your terminal:

export TOKEN=[the token you copied above]

Make sure you make that bot private in that page.


Adding your Bot


  1. On the side tab go to OAuth2>URL Generator.

  2. Under scopes, select bot.

  3. Under permissions, select admin.

  4. Use the generated URL to add it to your personal discord server to test out that your code is working correctly.

mermaidjs-discord's People

Contributors

yash-singh1 avatar ydkmlt84 avatar af-chacon avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.