Project review and documentation updates

[yinhe0597]

CardSyncElite

CardSyncElite is a JavaFX-based application for managing and synchronizing card data. It provides a user-friendly interface for handling various card operations and data synchronization tasks.

Features

• Card Management: Create, edit and delete cards
• Data Synchronization: Sync card data across multiple devices
• Rule-based Processing: Apply custom rules to card operations
• Task Automation: Automate repetitive card-related tasks
• Data Validation: Ensure data integrity and consistency

Requirements

• Java 17 or higher
• JavaFX 17.0.2
• Maven 3.8.1 or higher

Installation

1. Clone the repository:

   git clone https://github.com/yinhe0597/CardSyncElite.git

2. Navigate to project directory:

   cd CardSyncElite

3. Build the project:

   mvn clean install

4. Run the application:

   mvn javafx:run

Project Structure

CardSyncElite/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   ├── com/drinkcat/cardsyncelite/
│   │   │   │   ├── Main.java
│   │   │   │   ├── MainApplication.java
│   │   │   │   ├── controller/
│   │   │   │   │   ├── MainController.java
│   │   │   │   │   ├── RuleCardController.java
│   │   │   │   │   └── TaskCardController.java
│   │   │   │   ├── core/
│   │   │   │   │   ├── CoreCheckEngine.java
│   │   │   │   │   ├── CoreCopyEngine.java
│   │   │   │   │   ├── CoreSearchEngine.java
│   │   │   │   │   └── CoreSyncEngine.java
│   │   │   │   ├── module/
│   │   │   │   │   ├── SyncRule.java
│   │   │   │   │   └── SyncTask.java
│   │   │   │   └── util/
│   │   │   │       ├── AlertUtil.java
│   │   │   │       ├── DataStoreUtil.java
│   │   │   │       └── ExtensionsUtil.java
│   │   └── resources/
│   │       ├── com/drinkcat/cardsyncelite/view/
│   │       │   ├── InformWindow.fxml
│   │       │   ├── MainView.fxml
│   │       │   ├── RuleCardView.fxml
│   │       │   └── TaskCardView.fxml
│   │       └── META-INF/
│   │           └── MANIFEST.MF
├── libs/
│   ├── javafx-sdk-17.0.0.1/
│   └── javafx-sdk-17.0.2/
├── dbs/
│   └── data.db
├── pom.xml
└── README.md

Build Configuration

The project uses Maven with the following key dependencies:

• JavaFX Controls and FXML
• Log4j 2.17.2 for logging
• SQLite for local database storage

The pom.xml includes:

• JavaFX module configuration
• Maven JAR plugin for packaging
• Maven assembly plugin for creating fat JARs

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a pull request

License

This project is licensed under the MIT License - see the LICENSE file for details.