# tiger-task

**Repository Path**: prune/tiger-task

## Basic Information

- **Project Name**: tiger-task
- **Description**: Tiger-Task 是一个基于 Java 的开源任务管理平台，提供用户权限管理、代码生成、定时任务等基础功能。该项目使用 Spring Boot、Shiro、MyBatis、Druid、Quartz 等主流框架，适用于需要快速搭建后台管理系统的开发场景。
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2025-07-25
- **Last Updated**: 2026-01-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Tiger-Task

Tiger-Task is an open-source task management platform based on Java, providing fundamental features such as user permission management, code generation, and scheduled task management. This project utilizes mainstream frameworks including Spring Boot, Shiro, MyBatis, Druid, and Quartz, making it suitable for development scenarios requiring rapid setup of backend management systems.

## Functional Modules

- **User Management**: Supports user registration, login, role assignment, and permission control.
- **Permission Control**: Implements RBAC (Role-Based Access Control) based on Apache Shiro.
- **Code Generation**: Provides a visual code generation tool that supports automatic code generation for templates such as CRUD and tree structures.
- **Log Recording**: Records user operation logs and login logs.
- **Scheduled Tasks**: Uses Quartz to implement scheduled task scheduling management.
- **Multiple Data Sources Support**: Implements master-slave database configuration based on Druid.
- **Data Validation**: Supports security validation mechanisms such as XSS and SQL injection protection.

## Technology Stack

- Spring Boot
- Apache Shiro
- MyBatis
- Druid
- Quartz
- Velocity Template Engine
- Swagger API Documentation
- Lombok
- Ehcache
- MySQL (default support, extensible)

## Project Structure

- `tiger-task-common`: Common utility classes and basic components.
- `tiger-task-component`: Core system modules, including entities and Mappers for users, roles, permissions, configurations, etc.
- `tiger-task-generator`: Code generation module, supports automatic generation of front-end and back-end code from database tables.
- `tiger-task-framework`: Framework configuration module, including Shiro, Druid, MyBatis configurations.
- `tiger-task-quartz`: Scheduled task module.
- `tiger-task-web`: Spring Boot startup module, including Web configurations and login control.

## Quick Start

### 1. Clone the Repository

```bash
git clone https://gitee.com/prune/tiger-task.git
cd tiger-task
```

### Environment Requirements

- Java 17+
- Maven 3.x+
- MySQL 8.0+
- Redis (optional)

### 3. Database Configuration

Configure the database connection information in `tiger-task-framework/src/main/resources/application.yml`, for example:

```yaml
spring:
  datasource:
    druid:
      master:
        url: jdbc:mysql://localhost:3306/tiger_task?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
        username: root
        password: root
        driver-class-name: com.mysql.cj.jdbc.Driver
```

### 4. Start the Application

```bash
mvn spring-boot:run
```

Access `http://localhost:54321/task/login` and log in to the system using the default account and password.

## Usage Instructions

- After logging in, you can access the code generator at `/tool/gen`.
- System configurations can be managed via the `/system/config` route.
- User and role management can be performed at `/system/user` and `/system/role`.
- Scheduled task management is available at `/monitor/job`.

## Developer Documentation

- Access API documentation via Swagger: `http://localhost:54321/task/swagger-ui.html`
- System configuration documentation: `tiger-task-framework/src/main/java/com/guppy/framework/config`

## Contribution Guidelines

We welcome contributions of code and documentation. Please follow the guidelines below when submitting a PR:

1. Fork this repository and create a new branch.
2. Submit code and add relevant tests.
3. Update the README or related documentation.
4. Submit a PR and wait for review.

## Copyright and License

This project follows the MIT open-source license. For details, please refer to the LICENSE file. The project name and code are maintained by the Guppy development team. Copyright © 2023 Guppy Development Team.