Giter VIP home page Giter VIP logo

listbot's Introduction

LISTBOT

ListBot is a relatively simple Discord Bot, written in Javascript to create Lists in every channel.

Let's add everything we need on a community list!

image

๐ŸŽ‰ Inspiration

image

A couple of friends and me wanted to keep track of the movies we wanted to watch on our discord server, so I created ListBot to do that.

โœ… Add ListBot to your Discord Server

By clicking here, you can authorize ListBot to be used in your server.

You can also check out our Discord server in which we discuss what we can add to the bot, possible bug fixes, we sometimes have fun and something else in here.

๐Ÿ”‹ Usage

Once the bot is running and connected to your Discord channel and database you can use the following commands:

    * $add <component>: adds a component to the list
    * $multi-add <element> <element> - adds mutiple elements \in a list
    * $help: shows you a message with the available commands
    * $list: lists all the components \in the channel\'s list
    * $log: a log of the versions
    * $poll <active_time_in_minutes>: creates a poll on 5 random items of the list. If attribute is not supplied the poll has no limitation of time.
    * $random: gives you a random component from the list
    * $remove <component>: removes the desired component
    * $multi-remove <element> <element> - removes multiple elements \in a list
    * $remind <time_in_minutes> <component>: adds a component to the list and reminds you of it in n minutes

โญ Getting started

๐Ÿ’ป Installation

Learn how to create a Discord bot and get a valid token here.

๐Ÿ’พ To get started locally, follow these instructions:

  1. Clone to your local computer using git.
  2. Make sure you have Node installed; see instructions here.
  3. Make also sure that you have MongoDB installed; see instructions here.
  4. Create a copy of the .env.example file named .env found in ./src/config/.env.example and replace the placeholders with your bot token and MongoDB credentials
  5. Run npm install to install all dependencies
  6. Run npm run dev to start your server as development environment or npm run start for production

๐Ÿšข Docker

For development, you can run ListBot using Docker and Docker Compose following these steps below:

  • Adjust .env with your bot token
  • Run docker-composer up -d. This will build all containers on the first run and will be placed in the background
  • If you want to see the logs, just type docker-compose logs -f or read all in Portainer
  • If you want to stop, run docker-compose down

The docker-compose.yml file contains:

  • Mongo-express: *For database manager**
  • Mongo: The database itself
  • Server: ListBot
  • Portainer: To monitor your container services, such as logs, restarts and more.
    • You need to create a local user and password
    • Next page you need to choose docker local environment and after that click connect

To connect on:

  • Portainer: localhost:9000
  • Mongo-express: localhost: 8081

๐Ÿ—๏ธ Contribution Guidelines:

  • fork and clone this repository
  • Make a new branch using git checkout -b change/username
  • Commit the desired changes to that branch
  • Sign off your commits using git commit -s -m w/signoff
  • Push your changes to the branch and open a pull request

๐ŸŽƒ Contributors Hacktoberfest 2020:

tomassirio
Tomas Sirio
Peiprjs
Peipr
jledezma-mt
Javier Ledezma
AldoTu
AldoTurmon
TheRealLunatite
Luna
JDOG787
JDOG787
Fedelaus
Nathan Dawson
medusalix
Severin
Abhijay007
Abhijay Jain
AkiaCode
AkiaCode
anontyro
Alexander Wilkinson
Akshansh99
Akshansh Rewariya
CarlyRaeJepsenStan
CarlyRaeJepsenStan
manishkrjha
Manish Kumar Jha
simonardejr
Simonarde Lima
XysID
Xys
adhammo
Adham Mohamed
Aditya-ds-1806
Aditya DS
heyimalaap
Heyimalaap
Carolini28
Carolini Rodrigues
diogenesdauster
DiC3genes Dauster
hpbonfim
Henrique Paulo Bonfim
jsilvaigor
Igor Silva
joy98
JOY SARKAR
divn
Juuso Takala
thelovekesh
Lovekesh Kumar
phamducquanptit
Quan Pham
Sh1710
Sh1710
Toshiuk
Toshiuk
arthur-merlin
Arthur-merlin

Add yours!

๐Ÿ‘ค Who Am I?

listbot's People

Contributors

tomassirio avatar peiprjs avatar jledezma-mt avatar aldotu avatar lunatite avatar jdog787 avatar medusalix avatar abhijay007 avatar akiacode avatar anontyro avatar aaronzshey avatar hyonim avatar simonardejr avatar manishkrjha avatar akshansh99 avatar adhammo avatar adrienne14 avatar khai93 avatar arthur-merlin avatar toshiuk avatar phamducquanptit avatar thelovekesh avatar divn avatar joy98 avatar jsilvaigor avatar hpbonfim avatar diogenesdauster avatar carolini28 avatar heyimalaap avatar aditya-ds-1806 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.