TypicalBot

About TypicalBot

Note: This repository contains the code to the new version of TypicalBot that is under development. If you are looking for the current version of TypicalBot, visit the main repository.

A description about TypicalBot

Table of Contents

• Ecosystem
• Getting Started
  • Prerequisites
  • Installation
• Security Vulnerabilities
• License

Ecosystem

Project	Language	Description
rest proxy	TypeScript (Deno)	REST proxy to handle all Discord events.
gateway	TypeScript (Deno)	Gateway connection to Discord.
internal-api	Rust	REST api to handle all calls to the database.

Getting Started

This section provides a quick-start guide

Prerequisites

• Deno: Deno 11.1 or newer is required.
• Rust: Rust 1.54 or newer is required
• MongoDB: MongoDB 4.x or newer is required

Installation

1. Ensure all prerequisites are installed.
2. Clone the repository, ie. git clone https://github.com/typicalbot/typicalbot-deno.git
3. Cache the dependencies, ie. deno cache deps.ts
4. Create an .env file using the example file, fill out the missing variables.
5. Run deno run --unstable -A src/rest/mod.ts to start the REST proxy. Optionally, denox can be installed and the REST proxy can be started with denox run start:rest.
6. In a separate terminal, run deno run -A src/gateway/mod.ts to start the gateway. Optionally, denox can be installed and the gateway can be started with denox run start:gateway.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

License

TypicalBot is open source software licensed under the Apache License, Version 2.0. TypicalBot uses modifications of software developed by Discordeno in compliance with its license, a copy of which is available with the source of this software.