poixpixel-discord-bot/README.md
Ahmad 890ee028cc
chore: update README.md
Signed-off-by: Ahmad <103906421+ahmadk953@users.noreply.github.com>
2025-04-17 01:36:00 -04:00

38 lines
1.1 KiB
Markdown

# Poixpixel's Discord Bot
> [!WARNING]
> This Discord bot is not production ready and is still in a testing state.
> [!TIP]
> Want to see the bot in action? [Join our Discord server](https://discord.gg/KRTGjxx7gY).
## Documentation & Setup Instructions
> [!WARNING]
> Documentation is still under construction. Expect incomplete and undocumented features.
All documentation and setup instructions can be found at [https://docs.poixpixel.ahmadk953.org/](https://docs.poixpixel.ahmadk953.org/?utm_source=github&utm_medium=readme&utm_campaign=repository&utm_content=docs_link)
## Development Commands
Install Dependencies: ``yarn install``
Lint: ``yarn lint``
Check Formatting: ``yarn format``
Fix Formatting: ``yarn format:fix``
Compile: ``yarn compile``
Start: ``yarn target``
Undeploy All Commands: ``yarn undeploy-commands``
Build & Start (dev): ``yarn start:dev``
Build & Start without Command Deployment (dev): ``yarn start:dev:no-deploy``
Build & Start (prod): ``yarn start:prod``
Restart (works only when the bot is started with ``yarn start:prod``): ``yarn restart``