Skip to content

Cunga0X/Ticket-Bot

Repository files navigation

Contributors Forks Stargazers Issues MIT License


Logo

Tickets

Advanced Discord Tickets Bot
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

This project is a Discord Ticket Bot that provides a simple and efficient way to manage customer support on Discord servers. The bot allows users to create interactive tickets with customizable categories, questions, and responses. The bot also generates HTML transcripts of the closed tickets that can be viewed online or downloaded for future reference. The bot is easy to set up and use, and can handle multiple tickets simultaneously. The bot aims to improve the quality and speed of customer service on Discord platforms.

(back to top)

Built With

  • Express
  • DiscordJS

(back to top)

Getting Started

This bot offers you two options for using it. You can either add it to your server or run it on your own machine. The first option is easier and faster, while the second option gives you more control and customization. To host the bot yourself, please follow the instructions below.

Prerequisites

  1. Clone this project to your local machine using git clone https://github.com/Cunga0X/Ticket-Bot.git
  2. Use npm i to install all the required packages and dependencies

Installation

  1. Create a discord bot application at https://discord.com/developers/applications and get your bot token
  2. Configure the example-config.js file with your bot token and other settings and rename it to config.js
const { resolve } = require("path");

module.exports = {
  TOKEN: "your token",
  LOGS: "channel for error logs",
  MONGO_DB: "your mongodb uri",

  LANGUAGE: {
    defaultLocale: "en", // "en" = default language
    directory: resolve("Languages"), // <= location of language
  },

  // Options "web" or "local"
  TICKETS_HISTORY: "local",

  //WEBSERVER CONFIG
  PORT: 443,
  FQDM: "my.domain.com",
};
  1. For webserver ticket history, you will need to open a port for pages to be accessible. You can use ngrok or any other service to expose your local port to the internet

(back to top)

Usage

Soon

(back to top)

Roadmap

  • Add Changelog
  • Multi-language Support
    • Chinese
    • Spanish

See the open issues for a full list of proposed features (and known issues).

(back to top)

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.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

soon

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)