create-guilded-bot/packages/framework/javascript/README.md

23 lines
941 B
Markdown
Raw Normal View History

🚀 This is a guilded bot created using [create-guilded-bot](https://github.com/CompeyDev/create-guilded-bot).
## Getting Started
In order to run the development environment, configure your .env file with the required variables and then execute the following commands:
```bash
npm run dev
# or with yarn
yarn dev
```
Your bot should be online.
You can start editing the commands by adding/modifying files in the `commands` directory. An example help command is provided in
2022-11-21 08:59:57 +00:00
`commands/help.js`.
2022-11-21 08:59:57 +00:00
Events can also be customized by adding files to the `events` directory corresponding to the name of the event. See `events/ready.js` for an example event.
## Learn More
Since create-guilded-bot uses guilded.js, you can learn more from their [official docs](https://guilded.js.org/).
##### ✨ This template is highly inspired by reconlx's [djs-typescript-handler](https://github.com/reconlx/djs-typescript-handler), so give them a star :)