-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.txt
67 lines (60 loc) · 3.91 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
$ Compile the project
The project must be compiled in Java 1.8 or later.
The project is a Maven project, add the project as a Maven project in your IDE, the IDE will then automatically download the dependencies.
$ Run the project
Run the main method in MyFrame.class(gui.MyFrame.main).
$ Run test
The test is in MyTest.class, you may need to reset the file path in test cases.
The test works with TestNG plugin, you may need to download the plugin if it is not installed in your IDE.
If your IDE is Eclipse, useful link: https://www.lambdatest.com/blog/how-to-install-testng-in-eclipse-step-by-step-guide/
If your IDE is IntelliJ IDEA, you do not need TestNG plugin as TestNG is bundled in IntelliJ IDEA.
$ Package structure
.
├── file -------------------------------- The file folder
│ ├── user manual
│ │ └── FYP Grading Report Generator User Manual.pdf
│ ├── input file
│ │ ├── project marking - Template-v2-PM only.xlsx
│ │ ├── project marking - Template-v2-JS only.xlsx
│ │ └── project marking - Template-v3-PO only.xlsx
│ └── output file
│ ├── Computer_Science_FYP_Grading_Report_2022.pdf
│ └── Project_Marking_Combined_2022.xlsx
├── README.txt
├── pom.xml ----------------------------- Maven configuration XML
└── src
├── META-INF ------------------------ The information about the files packaged in a JAR file
│ └── MANIFEST.MF
├── main ---------------------------- The business code folder
│ ├── java
│ │ ├── gui
│ │ │ ├── MyFrame.form -------- Produced by IntelliJ GUI Designer
│ │ │ └── MyFrame.java -------- Java GUI source code
│ │ ├── pojo
│ │ │ └── Student.java
│ │ ├── service
│ │ │ ├── ExcelService.java
│ │ │ ├── MyService.java
│ │ │ ├── PdfEventHandler.java
│ │ │ └── PdfService.java
│ │ └── util
│ │ ├── ChartUtil.java
│ │ └── Constant.java
│ └── resources
│ ├── frame.properties -------- Defines the input label and text on GUI
│ └── log4j.properties -------- Defines the Log4J configuration
└── test ---------------------------- The test code folder
└── java
└── MyTest.java
>>>>>>>>>>>>>>>>>> Special Notes to The Developers of This Project >>>>>>>>>>>>>>>>>>
$ The editing of the GUI
The GUI of the project is developed with IntelliJ IDEA GUI Designer.
So IntelliJ IDEA(https://www.jetbrains.com/idea/download/) is highly recommended if you need to edit the GUI.
MyFrame.form contains the component layout information(can only be used in IntelliJ IDEA).
MyFrame.class contains the full source code that builds the GUI(can run in any IDE).
Assuming that you are using IntelliJ IDEA, you need to set th GUI fist: File >> Settings >> GUI Designer >> Generate GUI into: Java source code.
After finishing the GUI, do remember to rebuild the project, IntelliJ IDEA will automatically write the update in MyFrame.form into MyFrame.java, useful link: https://stackoverflow.com/questions/13744779/exporting-intellij-idea-ui-form-to-eclipse
$ Package the project
All configurations for packaging have been finished in pom.xml.
1) Use the Maven plugin in your IDE to package
2) Use command line, go to the root path of the project, execute: mvn clean package, then a target folder will be generated which contains the Jar file