-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit c867674
Showing
13 changed files
with
1,552 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
DIFY_API_KEY="app..." # Dify api secret key | ||
DIFY_API_BASE_URL="https://api.dify.ai/v1" # Dify instance base url | ||
DISCORD_BOT_TOKEN="" # Discord bot token from https://discord.com/developers/applications |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,130 @@ | ||
# Logs | ||
logs | ||
*.log | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
lerna-debug.log* | ||
.pnpm-debug.log* | ||
|
||
# Diagnostic reports (https://nodejs.org/api/report.html) | ||
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json | ||
|
||
# Runtime data | ||
pids | ||
*.pid | ||
*.seed | ||
*.pid.lock | ||
|
||
# Directory for instrumented libs generated by jscoverage/JSCover | ||
lib-cov | ||
|
||
# Coverage directory used by tools like istanbul | ||
coverage | ||
*.lcov | ||
|
||
# nyc test coverage | ||
.nyc_output | ||
|
||
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) | ||
.grunt | ||
|
||
# Bower dependency directory (https://bower.io/) | ||
bower_components | ||
|
||
# node-waf configuration | ||
.lock-wscript | ||
|
||
# Compiled binary addons (https://nodejs.org/api/addons.html) | ||
build/Release | ||
|
||
# Dependency directories | ||
node_modules/ | ||
jspm_packages/ | ||
|
||
# Snowpack dependency directory (https://snowpack.dev/) | ||
web_modules/ | ||
|
||
# TypeScript cache | ||
*.tsbuildinfo | ||
|
||
# Optional npm cache directory | ||
.npm | ||
|
||
# Optional eslint cache | ||
.eslintcache | ||
|
||
# Optional stylelint cache | ||
.stylelintcache | ||
|
||
# Microbundle cache | ||
.rpt2_cache/ | ||
.rts2_cache_cjs/ | ||
.rts2_cache_es/ | ||
.rts2_cache_umd/ | ||
|
||
# Optional REPL history | ||
.node_repl_history | ||
|
||
# Output of 'npm pack' | ||
*.tgz | ||
|
||
# Yarn Integrity file | ||
.yarn-integrity | ||
|
||
# dotenv environment variable files | ||
.env | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
.env.local | ||
|
||
# parcel-bundler cache (https://parceljs.org/) | ||
.cache | ||
.parcel-cache | ||
|
||
# Next.js build output | ||
.next | ||
out | ||
|
||
# Nuxt.js build / generate output | ||
.nuxt | ||
dist | ||
|
||
# Gatsby files | ||
.cache/ | ||
# Comment in the public line in if your project uses Gatsby and not Next.js | ||
# https://nextjs.org/blog/next-9-1#public-directory-support | ||
# public | ||
|
||
# vuepress build output | ||
.vuepress/dist | ||
|
||
# vuepress v2.x temp and cache directory | ||
.temp | ||
.cache | ||
|
||
# Docusaurus cache and generated files | ||
.docusaurus | ||
|
||
# Serverless directories | ||
.serverless/ | ||
|
||
# FuseBox cache | ||
.fusebox/ | ||
|
||
# DynamoDB Local files | ||
.dynamodb/ | ||
|
||
# TernJS port file | ||
.tern-port | ||
|
||
# Stores VSCode versions used for testing VSCode extensions | ||
.vscode-test | ||
|
||
# yarn v2 | ||
.yarn/cache | ||
.yarn/unplugged | ||
.yarn/build-state.yml | ||
.yarn/install-state.gz | ||
.pnp.* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2024 Pascal Malbranche | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
# Dify-Discord-Starter 🤖✨ | ||
|
||
Welcome to the **Dify-Discord-Starter** project! This is a modern and easy-to-use starter template for creating a Discord bot that integrates with the Dify app. Use this template to build your own bot and enable interactive chatting capabilities within your Discord community. | ||
|
||
## Features 🚀 | ||
|
||
- **Slash Command Support**: Users can interact with your bot using the `/chat` command directly in Discord. | ||
- **Integration with Dify**: Seamlessly send and receive messages through the Dify app. | ||
- **Ephemeral Responses**: Keep conversations private by sending ephemeral messages that only the command user can see. | ||
- **Simplified Bot Installation**: Easily add your bot to any Discord server with a single command. | ||
|
||
## Prerequisites 📋 | ||
|
||
Before you begin, ensure you have the following installed: | ||
- Node.js (v14 or higher) | ||
- npm (comes with Node.js) | ||
|
||
## Setup 🛠️ | ||
|
||
1. **Clone the Repository** | ||
```sh | ||
git clone https://github.com/your-username/dify-discord-starter.git | ||
cd dify-discord-starter | ||
``` | ||
|
||
2. **Environment Variables** | ||
- Rename `.env-example` to `.env`. | ||
- Fill in the environment variables with your own values. | ||
```plaintext | ||
DIFY_API_KEY="app..." # Your Dify API secret key | ||
DIFY_API_BASE_URL="https://api.dify.ai/v1" # Your Dify instance base URL | ||
DISCORD_BOT_TOKEN="" # Your Discord bot token from Discord Developer Portal | ||
``` | ||
|
||
3. **Install Dependencies** | ||
```sh | ||
npm install | ||
``` | ||
|
||
4. **Build the Project** | ||
```sh | ||
npm run build | ||
``` | ||
|
||
5. **Start the Bot** | ||
```sh | ||
npm start | ||
``` | ||
Upon startup, the bot will log a message in the console with a link to add the bot to your Discord server. | ||
|
||
6. **Add Your Bot to a Discord Server** | ||
Use the provided link in the console to add your bot to a Discord server. | ||
|
||
7. **Install Slash Commands** | ||
```sh | ||
npx ts-node scripts/install.ts <server-id> | ||
``` | ||
Replace `<server-id>` with the ID of the server where you want to install the command. | ||
|
||
## Usage 📖 | ||
|
||
Once the bot is added to your server and the slash command is installed, you can interact with it using the `/chat` command. Simply type `/chat` followed by your message, and the bot will respond with an ephemeral reply from the Dify app. | ||
|
||
## Scripts 📜 | ||
|
||
- `npm run build`: Compiles the TypeScript code to JavaScript, preparing it for execution. | ||
- `npm start`: Starts the bot using the compiled JavaScript code. | ||
- `npm run dev`: Runs the bot in development mode with hot reloading, ideal for development purposes. | ||
- `npm run install-cmd`: A shortcut script to run the install command script. | ||
|
||
## Contributing 🤝 | ||
|
||
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. | ||
|
||
1. Fork the Project | ||
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) | ||
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) | ||
4. Push to the Branch (`git push origin feature/AmazingFeature`) | ||
5. Open a Pull Request | ||
|
||
## License 📝 | ||
|
||
Distributed under the MIT License. See `LICENSE` for more information. | ||
|
||
## Acknowledgements 🙏 | ||
|
||
- [Discord.js](https://discord.js.org/#/) | ||
- [Dify.ai](https://dify.ai/) | ||
- [Node.js](https://nodejs.org/) | ||
|
||
--- | ||
|
||
Happy Coding! 🎉👩💻👨💻 | ||
|
||
*Note: This is a starter project and is not affiliated with the official Dify platform or Discord.* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"watch": ["src"], | ||
"ext": "ts,json", | ||
"ignore": ["src/**/*.spec.ts"], | ||
"exec": "ts-node ./src/index.ts" | ||
} | ||
|
Oops, something went wrong.