100 lines
2.4 KiB
Markdown
100 lines
2.4 KiB
Markdown
|
<div>
|
||
|
|
<p align="center">
|
||
|
|
<a href="https://discordx.js.org" target="_blank" rel="nofollow">
|
||
|
|
<img src="https://discordx.js.org/discordx.svg" width="546" />
|
||
|
|
</a>
|
||
|
|
</p>
|
||
|
|
<p align="center">
|
||
|
|
<a href="https://discordx.js.org/discord"
|
||
|
|
><img
|
||
|
|
src="https://img.shields.io/discord/874802018361950248?color=5865F2&logo=discord&logoColor=white"
|
||
|
|
alt="Discord server"
|
||
|
|
/></a>
|
||
|
|
<a href="https://www.npmjs.com/package/discordx"
|
||
|
|
><img
|
||
|
|
src="https://img.shields.io/npm/v/discordx.svg?maxAge=3600"
|
||
|
|
alt="NPM version"
|
||
|
|
/></a>
|
||
|
|
<a href="https://www.npmjs.com/package/discordx"
|
||
|
|
><img
|
||
|
|
src="https://img.shields.io/npm/dt/discordx.svg?maxAge=3600"
|
||
|
|
alt="NPM downloads"
|
||
|
|
/></a>
|
||
|
|
<a href="https://github.com/discordx-ts/discordx/actions"
|
||
|
|
><img
|
||
|
|
src="https://github.com/discordx-ts/discordx/workflows/Build/badge.svg"
|
||
|
|
alt="Build status"
|
||
|
|
/></a>
|
||
|
|
<a href="https://www.paypal.me/vijayxmeena"
|
||
|
|
><img
|
||
|
|
src="https://img.shields.io/badge/donate-paypal-F96854.svg"
|
||
|
|
alt="paypal"
|
||
|
|
/></a>
|
||
|
|
</p>
|
||
|
|
<p align="center">
|
||
|
|
<b> Create a discord bot with TypeScript and Decorators! </b>
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
# 📖 Introduction
|
||
|
|
|
||
|
|
A starter template equipped with several interaction commands and one event.
|
||
|
|
|
||
|
|
# 🏗 Development
|
||
|
|
|
||
|
|
```
|
||
|
|
npm install
|
||
|
|
npm run dev
|
||
|
|
```
|
||
|
|
|
||
|
|
If you want to use [Nodemon](https://nodemon.io/) to auto-reload while in development:
|
||
|
|
|
||
|
|
```
|
||
|
|
npm run watch
|
||
|
|
```
|
||
|
|
|
||
|
|
# 💻 Production
|
||
|
|
|
||
|
|
```
|
||
|
|
npm install --production
|
||
|
|
npm run build
|
||
|
|
npm run start
|
||
|
|
```
|
||
|
|
|
||
|
|
# 🐋 Docker
|
||
|
|
|
||
|
|
To start your application:
|
||
|
|
|
||
|
|
```
|
||
|
|
docker-compose up -d
|
||
|
|
```
|
||
|
|
|
||
|
|
To shut down your application:
|
||
|
|
|
||
|
|
```
|
||
|
|
docker-compose down
|
||
|
|
```
|
||
|
|
|
||
|
|
To view your application's logs:
|
||
|
|
|
||
|
|
```
|
||
|
|
docker-compose logs
|
||
|
|
```
|
||
|
|
|
||
|
|
For the full command list please view the [Docker Documentation](https://docs.docker.com/engine/reference/commandline/cli/).
|
||
|
|
|
||
|
|
# 📜 Documentation
|
||
|
|
|
||
|
|
- [discordx.js.org](https://discordx.js.org)
|
||
|
|
- [Tutorials (dev.to)](https://dev.to/samarmeena/series/14317)
|
||
|
|
|
||
|
|
# ☎️ Need help?
|
||
|
|
|
||
|
|
- [Check frequently asked questions](https://discordx.js.org/docs/faq)
|
||
|
|
- [Check examples](https://github.com/discordx-ts/discordx/tree/main/packages/discordx/examples)
|
||
|
|
- Ask in the community [Discord server](https://discordx.js.org/discord)
|
||
|
|
|
||
|
|
# 💖 Thank you
|
||
|
|
|
||
|
|
You can support [discordx](https://www.npmjs.com/package/discordx) by giving it a [GitHub](https://github.com/discordx-ts/discordx) star.
|