Approval System Backend

English | 简体中文

📌 Overview

Approval System Backend is a refactoring of the legacy approval system, built with Spring Boot and Maven.

🚀 Quick Start

Prerequisites

• Java 17 or higher
• MySQL 8.0+
• Maven 3.6+
• pre-commit

Installation

1. Clone the repository

   git clone https://github.com/NJUPT-SAST/approval-system-backend.git
   cd approval-system-backend

2. Install pre-commit hooks

   # For Arch Linux
   sudo pacman -S pre-commit
   # For Pipx users (cross-platform)
   pipx install pre-commit
   
   # Install the hook
   pre-commit install

3. Build the project

   mvn clean compile

4. Run the application

   # Option 1: Direct run
   mvn spring-boot:run -pl approval-server
   
   # Option 2: Package and run
   mvn clean package
   java -jar approval-server/target/approval-server-*.jar

Development

Code Formatting

This project uses Pre-commit for code formatting. Run the following command before you commit to format your code:

pre-commit run --all-files

Tip

If you encounter issues with pre-commit hooks, you can temporarily skip them using git commit --no-verify.

Contributing

Pull requests and any feedback are welcome. For major changes, please open an issue first to discuss what you would like to change.

Contributors

License

// TODO