mirror of
https://github.com/ahmadk953/poixpixel-discord-bot.git
synced 2025-05-10 10:43:06 +00:00
34 lines
879 B
Markdown
34 lines
879 B
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/)
|
|
|
|
## Development Commands
|
|
|
|
Install Dependencies: ``yarn install``
|
|
|
|
Lint: ``yarn lint``
|
|
|
|
Check Formatting: ``yarn format``
|
|
|
|
Fix Formatting: ``yarn format:fix``
|
|
|
|
Compile: ``yarn compile``
|
|
|
|
Start: ``yarn target``
|
|
|
|
Build & Start (dev): ``yarn start:dev``
|
|
|
|
Build & Start (prod): ``yarn start:prod``
|
|
|
|
Restart (works only when the bot is started with ``yarn start:prod``): ``yarn restart``
|