tickethub/README.md

71 lines
2.0 KiB
Markdown

# TicketHub
Enterprise-grade open-source ticket and issue tracking system.
## 🚀 Features
### Work Management
- 📊 **Dashboard** — Overview with KPIs and recent activity
- 🎫 **Tickets** — Full CRUD with filters, search, and bulk actions
- 📋 **Kanban Board** — Drag-and-drop ticket management
- 📁 **Projects** — Organize tickets by project with unique keys
### Team Collaboration
- 👥 **Team Management** — Invite members with role-based access
- 💬 **Comments** — Discussion threads on tickets
- 🔔 **Notifications** — Email and Slack alerts
### Enterprise Features
- 📈 **Reports & Analytics** — Performance metrics and insights
- 🔌 **Integrations** — GitHub, GitLab, Jira, ServiceNow, Slack
-**Automation** — Rules engine for repetitive tasks
- 🔐 **Security** — SSO, 2FA, IP restrictions
### API & Webhooks
- RESTful API with auto-generated documentation (Swagger UI)
- Incoming webhooks (create tickets from external systems)
- Outgoing webhooks (notify external systems on events)
- Project-level webhook configuration
## 📦 Tech Stack
| Layer | Technology |
|-------|-----------|
| **Frontend** | React 18, TypeScript, Vite, TailwindCSS |
| **Backend** | Python 3.11, FastAPI, SQLAlchemy |
| **Database** | SQLite (dev) / PostgreSQL (prod) |
## 🛠 Quick Start
```bash
# Clone
git clone https://gitea.startdata.com.br/startdata/tickethub.git
cd tickethub
# Backend
cd backend
pip install -r requirements.txt
uvicorn app.main:app --reload
# Frontend
cd frontend
npm install
npm run dev
```
## 📖 Documentation
- **[Installation Guide](INSTALL.md)** — Full setup instructions (Docker, Swarm, local dev)
- **[Architecture](docs/ARCHITECTURE.md)** — System design and data flow
- **[Developer Guide](docs/DEVELOPER_GUIDE.md)** — Contributing and extending
- **[User Guide](docs/USER_GUIDE.md)** — End-user documentation
- **[API Docs](https://tickethub.startdata.com.br/docs)** — Swagger UI
## 🌐 Live Demo
https://tickethub.startdata.com.br
## 📄 License
MIT © StartData