Git Product home page Git Product logo

discord-bot's Introduction

Task Manager Discord Bot

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Trying out commands
  5. Contributing

About The Project

This project has practical acquaintance purposes with the Golang programming language. Task Manager Bot is a Discord Bot that helps you to organize your tasks.

Built With

This discord bot is built with:

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

In order to run this project you will need the following:

  • Go 1.19.4 installed
  • Discord account
  • Configured MariaDB database

Installation

  1. Go to the Discord developer portal

  2. Create a new application

  3. Add a bot user to the application

  4. Get the token for the bot

  5. Clone the repository

    git clone https://github.com/oxanahr/discord-bot.git
  6. Install dependencies

    go mod download all
  7. Create the environment variables file .env in the root folder and add the following:

    DISCORD_TOKEN="Your discord token"
    SERVER_GENERAL_CHANNEL_ID="Discord server general channel id"
    DB_USER="Your database username"
    DB_PASSWORD="Your database password"
    DB_SCHEMA="Your database schema"
    DB_HOST="Your database host"
    DB_PORT="Your database port"

Usage

To run the discord bot from root directory, execute the following command

go run main.go

Trying out commands

The default prefix is / (slash)

   /add-task <task-name> <task-description> <priority> <assignee> <deadline>
   /assign-task <task-id> <assignee>
   /start-task <task-id>
   /complete-task <task-id>
   /my-tasks <order-by-deadline-or-priority> <deadline-current-week>
   /all-tasks <unassigned> <order> <soon>
   /comment <task-id> <comment-text>

Contributing

If you want to contribute to this project, feel free to do so.

discord-bot's People

Contributors

oxanahr avatar

Watchers

 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.