mirror of
https://github.com/Hessenuk/DiscordTickets.git
synced 2024-12-23 00:03:09 +02:00
docs: write an awesome README
This commit is contained in:
Isaac
parent
68765e530b
commit
4049202ab2
198
README.md
198
README.md
@ -1,48 +1,176 @@
|
||||
[](https://hosted.weblate.org/engage/discord-tickets/)
|
||||
|
||||
https://www.prisma.io/docs/reference/database-reference/supported-databases
|
||||
|
||||
 - for user/create, slash/force-close, slash/claim, slash/release, and slash/move
|
||||
|
||||
menu question max length cannot be higher than question options
|
||||
|
||||
ports <1024 require root
|
||||
|
||||
- TODO: update notifications
|
||||
> **Warning**
|
||||
>
|
||||
> This is the development branch, it may be unstable and may not work as expected.
|
||||
>
|
||||
> *dev notes:*
|
||||
> - https://static.eartharoid.me/k/22/08/02185801.png - for user/create, slash/force-close, slash/claim, slash/release, and slash/move
|
||||
> - menu question max length cannot be higher than question options
|
||||
> - ports <1024 require root
|
||||
> - TODO: update notifications
|
||||
> - TODO: user:create, force-close
|
||||
> - **likely to be rate limited by discord**:
|
||||
>
|
||||
> [](https://railway.app/new/template/eB6TkX?referralCode=Z3aYd2)
|
||||
|
||||
|
||||
creation requires an interaction:
|
||||
- [x] /new -> category? -> topic or questions -> create
|
||||
- [ ] user:create(self) -> category? -> topic or questions -> create
|
||||
- [ ] user:create(staff) -> category? -> DM (channel fallback) button -> topic or questions -> create
|
||||
- [x] message:create(self) -> category? -> topic or questions -> create
|
||||
- [ ] ~~message:create(staff) -> category? -> DM (channel fallback) button -> topic or questions -> create~~
|
||||
- [x] DM -> guild? -> category? -> topic or questions -> create
|
||||
- [x] panel(interaction) -> topic or questions -> create
|
||||
- [ ] ~~panel(message) -> DM (channel fallback) button -> topic or questions -> create~~
|
||||
|
||||
<div align="center">
|
||||
|
||||
|
||||
|
||||
[](https://github.com/discord-tickets/bot/stargazers)
|
||||
[](https://www.codacy.com/gh/discord-tickets/bot/dashboard)
|
||||
[](https://github.com/discord-tickets/bot/blob/main/CONTRIBUTORS.md)
|
||||
[](https://lnk.earth/discord)
|
||||
|
||||
<br>
|
||||
|
||||
|
||||
|
||||
**A free alternative to the premium and white-label plans of other ticket management bots.**
|
||||
|
||||
<br>
|
||||
|
||||
<a
|
||||
href="https://www.producthunt.com/posts/discord-tickets?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-discord-tickets"
|
||||
target="_blank">
|
||||
<img
|
||||
src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=321112&theme=light"
|
||||
alt="Discord Tickets - A free ticketing solution | Product Hunt"
|
||||
style="width: 250px; height: 54px;"
|
||||
width="250"
|
||||
height="54"
|
||||
/>
|
||||
</a>
|
||||
|
||||
<br>
|
||||
|
||||
---
|
||||
|
||||
[](https://pebble.host/discordtickets)
|
||||
|
||||
<br>
|
||||
|
||||
**[Partnered with PebbleHost](https://pebble.host/discordtickets)**
|
||||
|
||||
<sub>for affordable bot hosting</sub>
|
||||
|
||||
---
|
||||
|
||||
<br>
|
||||
</div>
|
||||
|
||||
## 📖 Contents
|
||||
|
||||
- [📖 Contents](#-contents)
|
||||
- [✨ Features](#-features)
|
||||
- [Want to learn more?](#want-to-learn-more)
|
||||
- [⚡ Getting started](#-getting-started)
|
||||
- [🤑 Sponsors](#-sponsors)
|
||||
- [🎖️ Contributors](#️-contributors)
|
||||
- [🧰 Contributing](#-contributing)
|
||||
- [🌎 Translating](#-translating)
|
||||
- [😕 Support](#-support)
|
||||
- [⭐ Star History](#-star-history)
|
||||
- [🥱 License](#-license)
|
||||
|
||||
|
||||
## ✨ Features
|
||||
|
||||
- 📖 [**Documentation**](https://discordtickets.app/getting-started/) - comprehensive documentation and guides to help you get started
|
||||
- ⚙️ **Simple settings** - configure your bot with the included and easy-to-use dashboard
|
||||
- 🎨 **Highly customisable** - tweak features, colours, messages, and more to your liking
|
||||
- 🛸 **Modern features** - including slash commands, buttons, select menus, and modals
|
||||
- 🤖 **Automation** - ease your staff team's workload with configurable automation
|
||||
- 🏷️ [**Tags**](https://v4--discordtickets.netlify.app/features/#tags) - resolve members' problems without escalating to tickets
|
||||
- 🎫 **Tickets** - close inactive tickets automatically
|
||||
- ❓ **Context** - ask for a topic or up to 5 custom questions before creating a ticket, and see references to a message or previous ticket at a glance
|
||||
- 🗃️ **Organisation** - claim, release, move and transfer tickets between members and categories
|
||||
- 🌎 [**Internationalisation**](#-translating) - available in more than 10 languages
|
||||
- ⏱️ **Statistics** - analyse your staff members' performance
|
||||
- 🪓 **Battle-tested** - trusted by thousands of servers, with over [half a million tickets](https://stats.discordtickets.app/) created since 2019
|
||||
- 🐳 [**Docker**](https://discordtickets.app/self-hosting/installation/docker/) - reliable and quick deployment with Docker
|
||||
|
||||
[*...and more!*](https://discordtickets.app/features/)
|
||||
|
||||
### Want to learn more?
|
||||
|
||||
**Visit [the website](https://discordtickets.app/) for more features, details, and screenshots**,
|
||||
or skip to the [full feature tour](https://discordtickets.app/features/).
|
||||
|
||||
## ⚡ Getting started
|
||||
|
||||
> *🙏 Please read the [documentation](https://discordtickets.app/self-hosting/installation/) before you start.*
|
||||
|
||||
There are 3 ways to get started with Discord Tickets:
|
||||
|
||||
- ☁️ [Add the public bot](https://discordtickets.app/public/) - instant setup, but branded *(great for testing)*
|
||||
- 😴 [Get a managed bot](https://discordtickets.app/managed/) - your own bot, hosted by me *(easy and cheap)*
|
||||
- 🧑💻 [Install your own bot](https://discordtickets.app/self-hosting/) - host it yourself *(⚠️ experience recommended)*
|
||||
|
||||
**[Read the documentation](https://discordtickets.app/getting-started/)** for more information.
|
||||
|
||||
> **Warning**
|
||||
> This button is here because it looks nice, but I will cry if you click it before reading the [documentation](https://discordtickets.app/getting-started/). :)
|
||||
|
||||
[](https://railway.app/new/template/eB6TkX?referralCode=Z3aYd2)
|
||||
|
||||
<!-- [](https://stackblitz.com/github/discord-tickets/bot) -->
|
||||
|
||||
## 🤑 Sponsors
|
||||
|
||||
Discord Tickets is made possible by its sponsors:
|
||||
|
||||
|
||||
|
||||
Please consider sponsoring the project if it adds value to your business/community.
|
||||
|
||||
**[Sponsor on GitHub](https://github.com/discord-tickets/bot/?sponsor=1)**, or
|
||||
|
||||
[](https://ko-fi.com/eartharoid)
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> test
|
||||
> Your logo will only appear here if you sponsor through GitHub Sponsors.
|
||||
> [Create an organisation](https://github.com/account/organizations/new?plan=free) if you want to use your business/community logo.
|
||||
|
||||
> **Warning**
|
||||
## 🎖️ Contributors
|
||||
|
||||
<!-- [](https://github.com/discord-tickets/bot/graphs/contributors) -->
|
||||
|
||||
Discord Tickets is made possible by all of the people listed in [CONTRIBUTORS.md](https://github.com/discord-tickets/bot/blob/main/CONTRIBUTORS.md).
|
||||
|
||||
|
||||
### 🧰 Contributing
|
||||
|
||||
If you want to help translate, suggest a feature, submit a bug report,
|
||||
or contribute in any other way, please read the [contributing guidelines](https://github.com/discord-tickets/.github/blob/main//CONTRIBUTING.md).
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> test
|
||||
> You can add yourself to the list of contributors [here](https://github.com/discord-tickets/bot/issues/new/choose).
|
||||
|
||||
<!-- <picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="...>
|
||||
<source media="(prefers-color-scheme: light)" srcset="...">
|
||||
<img alt="..." src="...">
|
||||
</picture> -->
|
||||
### 🌎 Translating
|
||||
|
||||
## Contributing
|
||||
[](https://hosted.weblate.org/engage/discord-tickets/)
|
||||
|
||||
https://commitlint.js.org/#/
|
||||
## 😕 Support
|
||||
|
||||
huksy?
|
||||
eslint
|
||||
secret scan
|
||||
[](https://lnk.earth/discord)
|
||||
|
||||
## Contributors
|
||||
## ⭐ Star History
|
||||
|
||||
[](https://github.com/discord-tickets/bot/graphs/contributors)
|
||||
<details>
|
||||
<summary>Show graph</summary>
|
||||
|
||||
[](https://star-history.com/#discord-tickets/bot&Date)
|
||||
|
||||
</details>
|
||||
|
||||
## 🥱 License
|
||||
|
||||
Discord Tickets by eartharoid™️ is licensed under the [GPLv3 license](https://github.com/discord-tickets/bot/blob/main/LICENSE).
|
||||
|
||||
This is not an official Discord product. It is not affiliated with nor endorsed by Discord Inc.
|
||||
|
||||
© 2023 Isaac Saunders
|
||||
Loading…
Reference in New Issue
Block a user