Tentix = Ten (10x Efficiency) Tix (Ticket System)

A FastGPT-powered AI customer service platform with 10x accelerated resolution.

🚀 10x Faster Response Speed
🤖 10x Reduced Human Intervention
😊 10x Improved User Satisfaction

📋 Table of Contents

Project Overview
Tech Stack
Project Structure
Quick Start
Development Guide
Database Scripts
Configuration Files
Deployment Guide
API Documentation
Contributing

🎯 Project Overview

Tentix is a modern AI-driven customer service system built with Monorepo architecture, integrating frontend interface, backend API, and AI processing capabilities. The system supports multi-channel integration (Feishu, etc.) and provides intelligent ticket processing, automatic replies, and seamless human-AI handover functionality.

Core Features

🤖 AI Smart Customer Service: Intelligent conversation system based on FastGPT
📱 Multi-Channel Integration: Support for Feishu, WeChat and other platforms
🎫 Ticket Management: Complete ticket lifecycle management
👥 Team Collaboration: Support for multi-department, multi-role collaboration
📊 Data Analytics: Real-time monitoring and data statistics
🔧 Scalable Architecture: Modular design, easy to extend

🛠 Tech Stack

Frontend Tech Stack

Framework: React 19 + TypeScript
Build Tool: Vite 6.1
Routing: TanStack Router
State Management: Zustand + TanStack Query
UI Components: Custom UI component library + Tailwind CSS 4.0
Rich Text Editor: TipTap
Code Highlighting: React Syntax Highlighter

Backend Tech Stack

Runtime: Bun
Framework: Hono 4.7
Database: PostgreSQL + Drizzle ORM
API Documentation: OpenAPI + Scalar
File Storage: MinIO
Caching: Node Cache
Rate Limiting: Hono Rate Limiter

Development Tools

Monorepo: Turborepo
Package Manager: Bun
Code Standards: ESLint + Prettier
Type Checking: TypeScript 5.8
Containerization: Docker + Docker Compose

📁 Project Structure

tentix-v2/
├── frontend/                 # Frontend application
│   ├── src/
│   │   ├── components/      # UI components
│   │   ├── routes/          # Route pages
│   │   ├── store/           # State management
│   │   ├── hooks/           # Custom Hooks
│   │   ├── lib/             # Utility libraries
│   │   └── modal/           # Modal components
│   ├── public/              # Static assets
│   └── package.json
├── server/                   # Backend service
│   ├── api/                 # API routes
│   ├── db/                  # Database configuration
│   ├── utils/               # Utility functions
│   ├── types/               # Type definitions
│   ├── script/              # Script files
│   ├── config.*.json        # Configuration files
│   └── package.json
├── packages/                 # Shared packages
│   ├── ui/                  # UI component library
│   ├── i18n/                # Internationalization
│   ├── eslint-config/       # ESLint configuration
│   └── typescript-config/   # TypeScript configuration
├── docker-compose.yml        # Docker Compose configuration
├── Dockerfile               # Docker image configuration
├── Makefile                 # Build scripts
├── turbo.json               # Turborepo configuration
└── package.json             # Root package configuration

🚀 Quick Start

Environment Requirements

Node.js >= 20
Bun >= 1.2.14
PostgreSQL
Docker (optional)

Install Dependencies

bun install

This Monorepo can only use Bun as the package manager.

Environment Configuration

Generate encryption key:

cd server
bun run script/getCryptoKey.ts

Copy configuration file template:

cp server/config.template.json server/config.dev.json

Configure environment variables:

cp .env.example .env.local
# Add the generated encryption key to .env.local

Initialize database:

cd server
bun run script/initDB.ts

(Optional) Generate seed data for development:

cd server
bun run seed

For detailed configuration instructions, see Configuration Files and Database Scripts sections.

Start Development Server

# Start development environment
bun run dev

# Or use Make command
make dev

Visit http://localhost:5173 to view the frontend application Visit http://localhost:3000/api/reference to view the backend API

💻 Development Guide

Development Commands

# Development environment
bun run dev              # Start development server
bun run build            # Build project
bun run lint             # Code linting
bun run format           # Code formatting
bun run typecheck        # Type checking
bun run test             # Run tests

# Database operations
cd server
bun run generate         # Generate database migrations
bun run migrate          # Execute database migrations
bun run studio           # Open Drizzle Studio
bun run seed             # Database seed data

# Database utility scripts
bun run script/getCryptoKey.ts      # Generate encryption keys
bun run script/initDB.ts            # Initialize database with users
bun run script/resetDB.ts           # Reset database completely
bun run script/migrateStaffList.ts  # Migrate staff from Feishu

# Helpful Bash Command
rm -rf ./**/turbo ./**/node_modules ./**/output ./**/dist

Code Standards

The project uses ESLint + Prettier for code standards management:

Use TypeScript strict mode
Follow React Hooks conventions
Components use PascalCase naming
Files use kebab-case naming
Automatically run lint checks before commits

Development Workflow

Create feature branch: git checkout -b feature/your-feature
Develop feature: Follow code standards for development
Run tests: bun run test to ensure tests pass
Code checking: bun run lint to fix code issues
Commit code: Use standardized commit messages
Create PR: Submit Pull Request for code review

🗄️ Database Scripts

The project includes several utility scripts for database management and system initialization. These scripts are located in server/script/ and handle various aspects of database setup, user management, and data migration.

Available Scripts

getCryptoKey.ts: Generate secure AES-256 encryption keys for the application
initDB.ts: Initialize database with system users, AI user, and staff members
resetDB.ts: Completely reset database schema and regenerate migrations
migrateStaffList.ts: Fetch and migrate staff data from Feishu platform
seed.ts: Generate realistic seed data for development and testing

Quick Setup Workflow

# 1. Generate encryption key
cd server && bun run script/getCryptoKey.ts

# 2. Initialize database
bun run script/initDB.ts

# 3. (Optional) Generate test data
bun run seed

For detailed information about each script, including usage examples, configuration requirements, and troubleshooting, see the Scripts Documentation.

⚙️ Configuration Files

Server Configuration (`server/config.*.json`)

{
  "$schema": "./config.schema.json",
  "feishu_app_id": "your_feishu_app_id",
  "feishu_app_secret": "your_feishu_app_secret",
  "aiProfile": {
    "uid": "0",
    "name": "Tentix AI",
    "nickname": "Tentix AI",
    "role": "ai",
    "avatar": "avatar_url"
  },
  "department_ids": ["department_id"],
  "agents_ids": ["agent_id"],
  "admin_ids": ["admin_id"],
  "staffs": [],
  "departments": []
}

Environment Variables (`.env.local`)

# Database configuration
DATABASE_URL=postgresql://username:password@localhost:5432/tentix
ENCRYPTION_KEY="q1cRtBG7J9YyFlPmeynwlJ1B+5Nu0SOa+hAUtUhh9lk="

# MinIO configuration
MINIO_ACCESS_KEY=your_access_key
MINIO_SECRET_KEY=your_secret_key
MINIO_BUCKET=your_bucket_name
MINIO_ENDPOINT=your_minio_endpoint

# FastGPT configuration
FASTGPT_API_URL=your_fastgpt_api_url
FASTGPT_API_KEY=your_fastgpt_api_key
FASTGPT_API_LIMIT=50

# Other configuration
NODE_ENV=development

Configuration File Description

config.dev.json: Development environment configuration
config.prod.json: Production environment configuration
config.template.json: Configuration template file
config.schema.json: Configuration file JSON Schema

🚢 Deployment Guide

Docker Deployment (Recommended)

Production Environment Deployment

# Deploy using Docker Compose
make docker-up

# Or use docker-compose directly
docker-compose up -d --build

Development Environment Build Testing

# Start development environment
make docker-dev

# Or use docker-compose
docker-compose --profile dev up --build

Manual Deployment

# 1. Build project
bun run build

# 2. Start production server
bun run start

# Or use PM2
pm2 start bun --name tentix -- run start

Deploy to Cloud Server

# 1. Build Docker image
make build

# 2. Push to image registry
make push DOCKER_REGISTRY=your-registry

# 3. Pull and run on server
docker pull your-registry/tentix:latest
docker run -d -p 3000:3000 your-registry/tentix:latest

Health Check

After deployment, you can check service status through the following endpoints:

Health check: GET /health
API documentation: GET /api/reference
Service status: GET /api/status

📚 API Documentation

Access API Documentation

After starting the service, visit the following addresses to view API documentation:

Scalar UI: http://localhost:3000/api/reference
OpenAPI JSON: http://localhost:3000/openapi.json

Main API Endpoints

GET    /api/health          # Health check
POST   /api/auth/login      # User login
GET    /api/tickets         # Get ticket list
POST   /api/tickets         # Create ticket
GET    /api/tickets/:id     # Get ticket details
PUT    /api/tickets/:id     # Update ticket
DELETE /api/tickets/:id     # Delete ticket

Authentication Method

API uses Bearer Token authentication:

curl -H "Authorization: Bearer your-token" \
     http://localhost:3000/api/tickets

🤝 Contributing

Submit Code

Fork the project to your GitHub account
Create feature branch: git checkout -b feature/amazing-feature
Commit changes: git commit -m 'Add amazing feature'
Push branch: git push origin feature/amazing-feature
Create Pull Request

Commit Message Standards

Use Conventional Commits standards:

feat: add new feature
fix: fix bug
docs: update documentation
style: format code
refactor: refactor code
test: add tests
chore: update dependencies

Code Review

All code changes need to go through Pull Request review:

Ensure all tests pass
Follow project code standards
Add necessary documentation and comments
Update related test cases

🆘 Support

If you encounter problems or have questions:

Check if there are similar issues in Issues
Create a new Issue describing your problem
Contact project maintainers

Happy Coding! 🎉

Name		Name	Last commit message	Last commit date
Latest commit History 54 Commits
.github		.github
.vscode		.vscode
frontend		frontend
packages		packages
server		server
.dockerignore		.dockerignore
.editorconfig		.editorconfig
.env.template		.env.template
.gitignore		.gitignore
.npmrc		.npmrc
DEVELOPMENT_GUIDE.md		DEVELOPMENT_GUIDE.md
Dockerfile		Dockerfile
Makefile		Makefile
README.md		README.md
SCRIPTS.md		SCRIPTS.md
bun.lock		bun.lock
docker-compose.yml		docker-compose.yml
eslint.config.mjs		eslint.config.mjs
package.json		package.json
tsconfig.json		tsconfig.json
turbo.json		turbo.json

labring/tentix

Folders and files

Latest commit

History

Repository files navigation

Tentix = Ten (10x Efficiency) Tix (Ticket System)

📋 Table of Contents

🎯 Project Overview

Core Features

🛠 Tech Stack

Frontend Tech Stack

Backend Tech Stack

Development Tools

📁 Project Structure

🚀 Quick Start

Environment Requirements

Install Dependencies

Environment Configuration

Start Development Server

💻 Development Guide

Development Commands

Code Standards

Development Workflow

🗄️ Database Scripts

Available Scripts

Quick Setup Workflow

⚙️ Configuration Files

Server Configuration (server/config.*.json)

Environment Variables (.env.local)

Configuration File Description

🚢 Deployment Guide

Docker Deployment (Recommended)

Production Environment Deployment

Development Environment Build Testing

Manual Deployment

Deploy to Cloud Server

Health Check

📚 API Documentation

Access API Documentation

Main API Endpoints

Authentication Method

🤝 Contributing

Submit Code

Commit Message Standards

Code Review

🆘 Support

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors 3

Uh oh!

Languages

Server Configuration (`server/config.*.json`)

Environment Variables (`.env.local`)

Packages