https://github.com/mibracy/goat
The system is built around the idea of providing a solid backend for a ticketing system, with a focus on a clean API and a data model that can be easily adapted to various business needs.
https://github.com/mibracy/goat
go json mariadb restful-api ticketing-system
Last synced: about 2 months ago
JSON representation
The system is built around the idea of providing a solid backend for a ticketing system, with a focus on a clean API and a data model that can be easily adapted to various business needs.
- Host: GitHub
- URL: https://github.com/mibracy/goat
- Owner: mibracy
- Created: 2025-07-06T08:44:36.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2026-03-17T01:44:22.000Z (4 months ago)
- Last Synced: 2026-05-03T21:35:01.523Z (about 2 months ago)
- Topics: go, json, mariadb, restful-api, ticketing-system
- Language: HTML
- Homepage:
- Size: 289 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GOAT - Greatest Of All Ticketing 🐐
✨ [Live Demo](http://goat.mibracy.duckdns.org) ✨
🐐 is not your average ticking system. Lightweight, modular, and extensible ticketing system built with Go.
It's designed to be a foundation for a robust and scalable customer support and issue tracking platform.
The project is structured with a clear separation of concerns, making it easy to understand, maintain, and extend. Architecture inspired by YATS
## Core Concepts
The system is built around the idea of providing a solid backend for a ticketing system, with a focus on a clean API and a data model that can be easily adapted to various business needs.
## Features
* **User Management:** Basic CRUD operations for managing users.
* `GET /admin`: List all users.
* `GET /admin/role/{role}`: List users by role (e.g., Admin, Agent, Customer).
* `POST /admin`: Create a new user.
* `GET /admin/{id}`: Get a user by their ID.
* `PUT /admin/update/{id}`: Update a user's information.
* `DELETE /admin/delete/{id}`: Delete a user.
* **Customer Management:** Basic CRUD operations for managing customers.
* `GET /admin/customers`: List all customers.
* **Ticket Management:** CRUD operations for managing tickets.
* `GET /admin/tickets`: List all tickets.
* `POST /admin/tickets`: Create a new ticket.
* `GET /admin/tickets/{id}`: Get a ticket by its ID.
* `PUT /admin/tickets/{id}`: Update a ticket's information.
* **Comment Management:** CRUD operations for managing comments.
* `GET /admin/comments`: List all comments.
* `POST /admin/comments`: Add a new comment to a ticket.
## How to Run
1. **Prerequisites:**
* Go (version 1.x or higher) installed.
* MariaDB installed.
2. **Clone the repository:**
```bash
git clone https://github.com/mibracy/goat.git
cd goat
```
2.5. **Create database db_schema.sql**
3. **Install dependencies:**
```bash
go mod tidy
```
4. **Run the application:**
```bash
go run main.go
```
5. **Using the HTML Page:**
Once the server is running, you can interact with the API's using the provided HTML page.
```bash
The server will start on `http://localhost:8420`
```
## Docker
To build the Docker image:
```bash
docker build -t goat-app .
```
To run the Docker container:
```bash
docker run -p 8420:8420 goat-app
```
### Environment Variables for Database Connection
The application uses environment variables to connect to the database. You can set the following variables when running the application (e.g., with `docker run -e`):
* `DB_HOST`: Database host (default: `127.0.0.1`)
* `DB_PORT`: Database port (default: `3306`)
* `DB_USER`: Database username (default: `casaos`)
* `DB_PASSWORD`: Database password (default: `casaos`)
* `DB_NAME`: Database name (default: `casaos`)
Example:
```bash
docker run -p 8420:8420 -e DB_HOST=your_database_ip -e DB_USER=your_user -e DB_PASSWORD=your_password -e DB_NAME=your_db_name goat-app
```
## Future Features
* **Authentication and Authorization:** Secure user authentication and role-based access control.
* **Customer Management:** Expanded CRUD for customer information.
* **Email Notifications:** Send email notifications for ticket updates.