Git Product home page Git Product logo

eddiebot's Introduction

EddieBot

The official EddieBot for the official Discord server. Join us at Discord today!

Features

  • Uses a powerful API built by the EddieHub community.
  • Checking all people's messages for inclusive language.

Config / Secrets environment variables

Copy .env.example to .env and add your private information

Note: never commit this file, it should be ignored by Git

DISCORD_TOKEN="<your-token>"
DISCORD_PREFIX="!"
API_URL=
API_TOKEN=

Note: to perform some of the reading/writing from the DB you will need the API project EddieHubCommunity/api

Installation

SSH

$ git clone [email protected]:EddieHubCommunity/EddieBot.git

GitHub CLI

$ gh repo clone EddieHubCommunity/EddieBot

HTTPS

$ git clone https://github.com/EddieHubCommunity/EddieBot.git
$ cd EddieBot
$ npm install

Discord Docs

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Support

EddieBot is an MIT-licensed open source project. It can grow thanks to the contributors and the community members. If you'd like to join them, feel free to make a pull request and we'll review it.

Stuck? Have any questions or comments? Join us on Discord and ask for help.

License

The EddieBot is licensed under the MIT license.

eddiebot's People

Contributors

abhint avatar adityaraute avatar akshu-on-github avatar allanregush avatar allcontributors[bot] avatar bolt04 avatar cahllagerfeld avatar chinmaymhatre avatar dependabot[bot] avatar eddiejaoude avatar eync avatar fi-krish avatar garretcharp avatar goluffyxd avatar kaiwalyakoparkar avatar luckspt avatar mikeysan avatar mstanciu552 avatar panquesito7 avatar prajwal0024 avatar prince1y avatar raisinten avatar ruth-ikegah avatar schmelto avatar starlightknown avatar stemount avatar utkarsh299-tech avatar verma-kunal avatar vyvy-vi avatar webkhushboo 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.