Git Product home page Git Product logo

zhinbot's Introduction

ZhinBot

Another multipurpose Discord bot.

Installation

  1. Configure secrets inside .env, use .env.example as a template
  2. Optionally you can configure config.toml, use config.default.toml as a template
  3. Run pnpm install to install dependencies
  4. Run pnpm prebuild to setup the database
  5. Run pnpm build to transpile the project

Run pnpm start to start

Scripts

  • start - Starts the builded bot (runnig node . directly is slightly more effective), use with NODE_ENV=production in production

Building

  • prebuild - Sets up database with Prisma and builds the Prisma client
  • build - Transpiles Typescript

Development

  • watch - Transpiles Typescript with source maps and re-transpiles on changes

  • dev - Start the bot in development mode (uses source maps, use concurrently with watch; note that you have to restart this script manually on changes to prevent hitting rate-limit from Discord)

  • dev:dry - Start the bot in dry development mode; no transpilation, automatic restarts, but won't sign in to Discord.

  • check - Checks source code typings with TSC

  • lint - Lints source code with Eslint

  • format - Formats source code with Prettier

Misc

  • generateDocs - Auto-generates command list in docs/modules/ folder

zhinbot's People

Contributors

zhincore avatar

Watchers

 avatar  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.