readme.md

Tickets Documentation

All documentation for the Discord bot "Tickets"
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Documentation Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

User-facing documentation for Tickets. Tickets is a simple, customisable, and powerful Discord ticket system bot complete with a web UI.

(back to top)

Documentation Built With

• 

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps:

Prerequisites

Node.JS v20 or higher is installed

Installation

1. Install dependencies by running: npm i

2. Run: npm run dev or npx vitepress dev docs to get a local instance running which will allow you to preview your changes in a live updating preview on http://localhost:5173/.

(back to top)

Usage

(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. Make your Changes. Copy the changed file(s) and replace the original/add it in the translation directories.
4. Commit your Changes (git commit -m 'Add some AmazingFeature')
5. Push to the Branch (git push origin feature/AmazingFeature)
6. Open a Pull Request

(back to top)

Top contributors:

License

section coming soon

(back to top)

Contact

Project Link: https://github.com/TicketsBot-cloud/docs

(back to top)