https://github.com/typicalbot/typicalbot

TypicalBot is open-source Discord bot written in TypeScript, using the Discord.js library.
https://github.com/typicalbot/typicalbot

bot discord discord-bot discordapp discordjs hacktoberfest javascript typescript typicalbot

Last synced: 3 months ago
JSON representation

TypicalBot is open-source Discord bot written in TypeScript, using the Discord.js library.

• Host: GitHub
• URL: https://github.com/typicalbot/typicalbot
• Owner: typicalbot
• License: apache-2.0
• Archived: true
• Created: 2016-11-06T22:37:37.000Z (about 8 years ago)
• Default Branch: canary
• Last Pushed: 2021-10-28T02:29:43.000Z (about 3 years ago)
• Last Synced: 2024-09-21T18:25:36.387Z (3 months ago)
• Topics: bot, discord, discord-bot, discordapp, discordjs, hacktoberfest, javascript, typescript, typicalbot
• Language: TypeScript
• Homepage: https://typicalbot.com
• Size: 4.67 MB
• Stars: 69
• Watchers: 4
• Forks: 18
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        


    
TypicalBot


> We have begun development on our next version of TypicalBot that is built on the Deno runtime and Rust. Checkout our two new repositories [typicalbot-deno](https://github.com/typicalbot/typicalbot-deno) and [typicalbot-internal-api](https://github.com/typicalbot/typicalbot-internal-api)!



    

    

    



## About TypicalBot

TypicalBot is far from typical. It's stable, lightning fast, and easy to use— TypicalBot will seamlessly help you moderate your server and provide entertainment for its members, no problem at all!

 - [Multilingual](https://translate.typicalbot.com)

 - Moderation

 - Customization

 - Entertainment

## Table of Contents

- [Getting Started](#getting-started)

    - [Prerequisites](#prerequisites)

    - [Installation](#installation)

- [Show Your Support](#show-your-support)

- [Security Vulnerabilities](#security-vulnerabilities)

- [License](#license)

## Getting Started

This section provides a quick-start guide.

### Prerequisites

- [Node.js](https://nodejs.org/en/): Node.js 14.x or newer is required.

- [MongoDB](https://www.mongodb.com/): MongoDB is required.

- [PM2](http://pm2.keymetrics.io/): PM2 is required.

**Windows Only**

- [Windows Build Tools](https://github.com/felixrieseberg/windows-build-tools): Python 2.7 and VisualStudio is required to compile dependencies.

### Installation

1. Make sure all prerequisites above are installed.

2. Clone the repository, ie. `git clone https://github.com/typicalbot/typicalbot.git`

3. Install the dependencies with `yarn`

4. Run `yarn build:database` to build the database structure.

5. While the above is running create your `.env` file using the example file provided in the repo.

6. Run `yarn build:instance`

7. Success!

## Show Your Support

If you like what we do, consider supporting us on [Patreon](https://patreon.com/typicalbot).

## Security Vulnerabilities

Please review our [security policy](https://github.com/typicalbot/typicalbot/security/policy) on how to report security vulnerabilities.

## License

TypicalBot is an open source software licensed under the [Apache 2.0 license](LICENSE).