File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ # CIM Project Guide
2+
3+ CIM (Cross-platform Instant Messaging) is a Java-based instant messaging framework.
4+
5+ ## Requirements
6+
7+ - ** Minimum JDK Version** : JDK 17
8+ - ** Build Tool** : Maven
9+ - ** Spring Boot Version** : 3.3.0
10+
11+ ## Environment Setup
12+
13+ Before running compile or test commands, set the correct JDK version:
14+
15+ ``` bash
16+ export JAVA_HOME=$JAVA_17_HOME
17+ ```
18+
19+ ` JAVA_17_HOME ` is defined in ` ~/.zshrc ` .
20+
21+ ## Common Commands
22+
23+ ### Compile the project
24+ ``` bash
25+ mvn clean compile
26+ ```
27+
28+ ### Run tests
29+ ``` bash
30+ mvn test
31+ ```
32+
33+ ### Package the project
34+ ``` bash
35+ mvn clean package -DskipTests
36+ ```
37+
38+ ### Full build (with tests)
39+ ``` bash
40+ mvn clean install
41+ ```
42+
43+ ## Notes
44+
45+ - Checkstyle code style checks run automatically during Maven's ` validate ` phase
46+ - Ensure code passes Checkstyle checks before committing
You can’t perform that action at this time.
0 commit comments