Skip to content

muurt/pyreworker

Repository files navigation

PYREWORKER

Pyreworks center bot, running the Auto-Mod, handling tickets and even more.

Dependencies

This bot uses MongoDB and Prisma for the database functions.
Prettier and ESLint for linting functions.
Typescript and Node.js for running functions.
Discord.js for interacting with the Discord API.
Winston for console logging. Perspective for analysing messages.

Running

NOTE: If you're on windows and if you get an error that says "The system cannot find the file specified.", change the "prebuild" script in package.json to

    "prebuild": "rmdir /s /q out",

(Make this change ONLY if npm run build doesn't work)

To run this you need to rename ".env.example" to ".env" and add the corresponding tokens. You need to have Node.js installed, and then you need to run in order;

# Installing the required dependencies
npm install
npm install --save-dev
# Updating the packages
npm update
npm update --save-dev
# Generating Prisma files
npx prisma generate # IMPORTANT: Make sure to have (Microsoft Visual C++ 2015 Redistributable) for this to work
# Linting the project (checks for linting issues)
npm run lint
# Building the project (changes TS to JS)
# IMPORTANT: Before running the build command make sure to run
mkdir out # This is so the windows commands work correctly
npm run build
# Starts the bot
npm run start

When you change the code you need to run npm run build for the changes to take effect.

When committing changes mention the simplified form of what you've done in the commit comment.

  • Please use (fix: feat: review:) tags when committing, no uppercase allowed.

Comments

To get a better view of comments, please use "Better Comments".

About

The worker bot for PYREWORKS.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published