Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bot-ts/framework

TypeScript framework in TypeScript includes an advanced command handler, a cli to generate files, a very practical file structure, a yargs based argument system for commands, an advanced Eval command, a Knex based database provider and some utils...
https://github.com/bot-ts/framework

cli-app discord discordbot discordjs easy typescipt

Last synced: 26 days ago
JSON representation

Host: GitHub
URL: https://github.com/bot-ts/framework
Owner: bot-ts
Created: 2020-11-11T02:05:08.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2024-04-22T12:43:21.000Z (9 months ago)
Last Synced: 2024-04-22T12:50:02.654Z (9 months ago)
Topics: cli-app, discord, discordbot, discordjs, easy, typescipt
Language: TypeScript
Homepage: https://ghom.gitbook.io/bot-ts/
Size: 930 KB
Stars: 25
Watchers: 3
Forks: 3
Open Issues: 1
Metadata Files:
- Readme: readme.md

Awesome Lists containing this project

README

        


   @ghom/bot.ts 

 A Discord bot in TypeScript made with bot.ts 

  

    

      

    

  

  

    

    

    

    

    

    

    

  






## What is bot.ts?

**bot.ts** is a framework for [discord.js](https://discord.js.org/#/) designed in TypeScript for use in TypeScript. This framework includes all the features you need, here is a list:

- **Package Manager Agnostic**: Compatible with [npm](https://www.npmjs.com), [yarn](https://yarnpkg.com), [pnpm](https://pnpm.io) and more.

- **Multi-Runtime Support**: Fully compatible with [Node.js](https://nodejs.org), [Bun](https://bun.sh), and [Deno](https://deno.land).

- **File Handling**: Robust file handling using [@ghom/handler](https://www.npmjs.com/package/@ghom/handler).

- **CLI File Generation**: Easy and powerful file generation using [@ghom/bot.ts-cli](https://www.npmjs.com/package/@ghom/bot.ts-cli).

- **Node Aliases**: Simplify module resolution with useful path aliases using [Node.js 'imports'](https://nodejs.org/api/packages.html#packages_imports).

- **Shell Arguments**: Handle type-safe shell arguments on textual commands using [Yargs](http://yargs.js.org/).

- **Predefined Commands & Listeners**: Ready-to-use dev-[commands](https://github.com/bot-ts/framework/blob/master/src/commands) and system-[listeners](https://github.com/bot-ts/framework/blob/master/src/listeners).

- **Advanced Scripts**: Configured advanced dev tools in [package.json's scripts and CLI](https://ghom.gitbook.io/bot-ts/command-line/overview).

- **ORM Setup**: Preconfigured [Knex](http://knexjs.org/)-based ORM with [sqlite3](https://www.npmjs.com/package/sqlite3) using [@ghom/orm](https://www.npmjs.com/package/@ghom/orm).

- **Pagination**: Efficient pagination in the [help command](https://github.com/bot-ts/framework/blob/master/src/commands/help.native.ts#L35).

- **Fast Build**: Builds fast with [Rollup](https://rollupjs.org).

- **TypeScript Checks**: Generated CI/CD using [GitHub Actions](https://github.com/bot-ts/framework/blob/master/.github/workflows/test.yml).

- **Logging**: Beautiful console logging using [@ghom/logger](https://www.npmjs.com/package/@ghom/logger).

- **Framework Updates**: Stay up to date with the integrated [updater](https://github.com/bot-ts/framework/blob/master/scripts/update-framework.js).

- **Docker**: Run with [Docker](https://www.docker.com) via [Dockerfile](https://github.com/bot-ts/framework/blob/master/Dockerfile) or [compose.yml](https://github.com/bot-ts/framework/blob/master/compose.yml).

- **Data Caching**: Reduce database and API requests with built-in caching.

## What's next?

- Localhost Admin Dashboard

- Data Caching imporovement

- Make optional the textual command system

- Move all advanced scripts into CLI

- Publish the CLI as JSR package

## Why using bot.ts?

Modern, intuitive, and easy to use. Choosing **Bot.ts** is choosing control.

* It's not a lib! You can edit all files easily.

* All is already configured.

* I recommend it for learning TypeScript.

* It is up to date with all technologies.

## Hello World

![bot.ts hello world](https://media.githubusercontent.com/media/bot-ts/docs/refs/heads/master/.gitbook/assets/bot.ts-helloworld.webp)

## Annexes

* [GitHub](https://github.com/bot-ts) - Come contribute 🩵

* [Documentation](https://ghom.gitbook.io/bot-ts/)

* [Package](https://www.npmjs.com/package/@ghom/bot.ts-cli) of CLI on NPM

* [Discord](https://discord.gg/kYxDWWQJ8q) to track the progress of the project.

* [Community](https://discord.gg/3vC2XWK) - Les Laboratoires JS

## Funding