Giter Club home page Giter Club logo

cx-bot's Introduction

CxBot

A Discord Bot based on Discord.js and the Sapphire Framework

Codacy Badge

CxBot is a Discord bot that allows me to automate and improve many aspects of Discord.

to run

  1. Install dependencies with npm i

  2. Fill out a new file called .env with the template in .env.schema

  3. Run tsc and compile the project

  4. If the compilation succeeded, proceed to run the bot by doing node dist &

  5. If you want to work with trello integration, you will need a postgres database. Use prisma to generate the tables and such. To do that,

    1. Set the database url in the .env file. It should look something like: DATABASE_URL="postgres://{user}:{password}@{location[localhost]}:{port}/{dbname}&schema={schema type [probably public]}"

    2. After, run npx prisma migrate dev --name init

    3. Now, to get the client run npm install @prisma/client

    4. If you plan on changing the database, you will need to migrate the structure with npm install @prisma/client

Architecture

./src/                  Root directory.
  |-bot/                Sapphire specific directory.
  | |-arguments/        Custom arguments for commands.
  | |-commands/         Commands.
  | |-listeners/        Event listeners.
  | |-preconditions/    Preconditions for commands.
  | |-tasks/            Tasks running on cron intrevals.
  |-lib/                Util and backend logic.
  | |-extensions/       Classes that extend library classes.
  | |-Task/             Task's piece and store.
  | |-utils/            General utility functions.
  |-prisma/             Prisma & database specific files.
  |-typings/            Custom typescript types.

cx-bot's People

Contributors

codacy-badger avatar codermandavid avatar nmathira avatar renovate-bot avatar renovate[bot] avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

cx-bot's Issues

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: Cannot find preset's package (github>whitesource/merge-confidence:beta)

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Pending Approval

These branches will be created by Renovate only once you click their checkbox below.

  • chore(deps): update actions/checkout action to v3
  • chore(deps): update dependency @types/node to v18
  • chore(deps): update dependency prettier to v3
  • chore(deps): update github/codeql-action action to v2
  • fix(deps): update dependency @sapphire/decorators to v6
  • fix(deps): update dependency @sapphire/discord.js-utilities to v7
  • fix(deps): update dependency @sapphire/framework to v4
  • fix(deps): update dependency @sapphire/plugin-editable-commands to v3
  • fix(deps): update dependency discord.js to v14
  • fix(deps): update dependency utf-8-validate to v6
  • fix(deps): update prisma monorepo to v5 (major) (@prisma/client, prisma)
  • ๐Ÿ” Create all pending approval PRs at once ๐Ÿ”

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

  • chore(deps): lock file maintenance

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

  • chore(deps): update github/codeql-action action to v1.1.39

Pending Branch Automerge

These updates await pending status checks before automerging. Click on a checkbox to abort the branch automerge, and create a PR instead.

  • chore(deps): update dependency @types/node to v16.18.43

Detected dependencies

github-actions
.github/workflows/codeql-analysis.yml
  • actions/checkout v2.7.0@ee0669bd1cc54295c223e0bb666b733df41de1c5
  • github/codeql-action v1.0.20@e86ea38e3f233a8bcf5afc904ee9fb422d5cf6e8
  • github/codeql-action v1.0.20@e86ea38e3f233a8bcf5afc904ee9fb422d5cf6e8
  • github/codeql-action v1.0.20@e86ea38e3f233a8bcf5afc904ee9fb422d5cf6e8
npm
package.json
  • @prisma/client ^3.0.0
  • @sapphire/decorators ^4.0.0
  • @sapphire/discord.js-utilities ^4.0.0
  • @sapphire/fetch ^2.0.3
  • @sapphire/framework ^2.0.0-next.71c18830.0
  • @sapphire/pieces ^3.0.0
  • @sapphire/plugin-editable-commands ^1.0.1
  • @sapphire/stopwatch ^1.1.4
  • @sapphire/type ^2.0.11
  • @sapphire/utilities ^3.0.0
  • ansi-regex >=5.0.1
  • bufferutil ^4.0.3
  • colorette ^2.0.2
  • discord.js ^13.0.1
  • dotenv-extended ^2.9.0
  • module-alias ^2.2.2
  • node-cron ^3.0.0
  • pg ^8.7.1
  • pg-hstore ^2.3.4
  • utf-8-validate ^5.0.5
  • zlib-sync ^0.1.7
  • @types/node 16.18.41
  • @types/node-cron 3.0.8
  • prettier 2.8.8
  • prisma 3.15.2

  • Check this box to trigger a request for Renovate to run again on this repository

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.