Git Product home page Git Product logo

pollbot's Introduction

pollbot

Discord bot for taking community polls

Structure

  • packages - base directory for shareable packages
    • idl-ts - generated from projects/idl build
  • projects
    • discord-bot - pollbot Discord bot code. Handles commands, interactions, persistence, etc.
    • idl - (interface description language) contains protobuf definitions for domain models and messages used in network requests/responses, document storage, and business logic.

How to build

There are some handy scripts (which may or may not work in your environment).

Tools

Build IDL

cd projects/idl
make init # This should install Buf. If this fails, install Buf and protobuf. 
make build # This should build `packages/idl-ts`. This is a dependency for `projects/discord-bot`

Storage Setup

You will need to set up a new Firestore project and enable Firestore. Then set up your development environment using instructions found in projects/discord-bot.

Discord Setup

You will need to create a new Discord application and set up a new bot user for it. Ensure that the bot invite has all permissions you need for pollbot (application commands, read message history, etc).

Environment Setup

Discord and Firestore require some environment variables to be created for pollbot to function. These can be seen in projects/discord-bot/src/settings.ts. If documentation in projects/discord-bot is not sufficient, please reach out to my discord server or leave an issue on this repo to have documentation improved.

pollbot's People

Contributors

qntnt avatar

Stargazers

 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.