Merge pull request #35 from pufanyi/dev/new_project_page

new project page
pufanyi · Dec 22, 2023 · ebf0147 · ebf0147
2 parents 8db909a + 6903335
commit ebf0147
Show file tree

Hide file tree

Showing 606 changed files with 124,010 additions and 1,655 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,13 @@
+cff-version: 1.2.0
+message: "If you use or build on this work, please cite it as below."
+authors:
+  - family-names: Pu
+    given-names: Fanyi
+  - family-names: Jin
+    given-names: Qingyang
+  - family-names: Soo
+    given-names: Ying Xi
+  - family-names: Jiang
+    given-names: Jinyi
+title: "FYPMS: Final Year Project Management System"
+date-released: 2023-04-16
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# FYPMS
+# FYPMS: Final Year Project Management System
 
 NTU AY2022/23 Semester 2 SC2002 Group Project - Final Year Project Management System (FYPMS).
 
@@ -11,7 +11,7 @@ The initial password for every user is `password`.
 - [Main Page](https://pufanyi.github.io/FYPMS)
 - [GitHub Repository](https://github.com/pufanyi/FYPMS)
 - [Documentation](https://pufanyi.github.io/FYPMS/docs)
-- [Report](report)
+- [Report](docs/report)
 - [Presentation Video](https://youtu.be/8FikWzfHlLA)
 
 ## Team Members
@@ -26,6 +26,7 @@ We are a group 6 from tutorial group A50, Nanyang Technological University, Sing
 | Soo Ying Xi  | [niyaojiayou](https://github.com/niyaojiayou)   | [D220001@e.ntu.edu.sg](mailto:D220001@e.ntu.edu.sg)  |
 
 ## Highlights
+
 - **Reflection**: The interface `Model` uses reflection to convert between classes and strings, enabling dynamic handling of model data without manual mapping.
 - **Generic Repository Class**: `Repository<Model>` class with generics allows for flexible data storage and retrieval for any model type, reducing duplication and improving maintainability.
 - **SHA-3 Password Encryption**: User passwords are encrypted using the SHA-3 algorithm for enhanced
@@ -102,18 +103,23 @@ The java class `src/test/HardReload.java` is used to hard reload the database.
 
 ## UML Class Diagram
 
-### Main Diagram
-
-[![Main Diagram](UMLClassDiagram/main.svg)](UMLClassDiagram/main.svg)
+The uml diagram is generated by [draw.io](https://draw.io/).
 
-### Entity Sub-Diagram
+You can refer to the [project main page](https://pufanyi.github.io/FYPMS) for the UML class diagram.
 
-[![Entity Sub-Diagram](UMLClassDiagram/entity.svg)](UMLClassDiagram/entity.svg)
+[Here](umls) is the source code of the UML class diagram.
 
-### Controller Sub-Diagram
+## BibTeX
 
-[![Controller Sub-Diagram](UMLClassDiagram/controller.svg)](UMLClassDiagram/controller.svg)
+```bibtex
+@software{Pu_FYPMS_Final_Year_2023,
+  author  = {Pu, Fanyi and Jin, Qingyang and Soo, Ying Xi and Jiang, Jinyi},
+  month   = apr,
+  title   = {{FYPMS: Final Year Project Management System}},
+  year    = {2023}
+}
+```
 
-### Boundary Sub-Diagram
+## License
 
-[![Boundary Sub-Diagram](UMLClassDiagram/boundary.svg)](UMLClassDiagram/boundary.svg)
+[MIT](LICENSE) © Pu Fanyi, Jin Qingyang, Soo Ying Xi, Jiang Jinyi
diff --git a/css/style.css b/css/style.css
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,2 @@
+.DS_store
+.idea
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,16 @@
+# Nerfies
+
+This is the repository that contains source code for the [Nerfies website](https://nerfies.github.io).
+
+If you find Nerfies useful for your work please cite:
+```
+@article{park2021nerfies
+  author    = {Park, Keunhong and Sinha, Utkarsh and Barron, Jonathan T. and Bouaziz, Sofien and Goldman, Dan B and Seitz, Steven M. and Martin-Brualla, Ricardo},
+  title     = {Nerfies: Deformable Neural Radiance Fields},
+  journal   = {ICCV},
+  year      = {2021},
+}
+```
+
+# Website License
+<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.
diff --git a/UMLClassDiagram/boundary.drawio → docs/UMLClassDiagram/boundary.drawio b/UMLClassDiagram/boundary.drawio → docs/UMLClassDiagram/boundary.drawio
diff --git a/UMLClassDiagram/boundary.png → docs/UMLClassDiagram/boundary.png b/UMLClassDiagram/boundary.png → docs/UMLClassDiagram/boundary.png
diff --git a/UMLClassDiagram/boundary.svg → docs/UMLClassDiagram/boundary.svg b/UMLClassDiagram/boundary.svg → docs/UMLClassDiagram/boundary.svg
diff --git a/UMLClassDiagram/controller.drawio → docs/UMLClassDiagram/controller.drawio b/UMLClassDiagram/controller.drawio → docs/UMLClassDiagram/controller.drawio
diff --git a/UMLClassDiagram/controller.png → docs/UMLClassDiagram/controller.png b/UMLClassDiagram/controller.png → docs/UMLClassDiagram/controller.png
diff --git a/UMLClassDiagram/controller.svg → docs/UMLClassDiagram/controller.svg b/UMLClassDiagram/controller.svg → docs/UMLClassDiagram/controller.svg
diff --git a/UMLClassDiagram/entity.drawio → docs/UMLClassDiagram/entity.drawio b/UMLClassDiagram/entity.drawio → docs/UMLClassDiagram/entity.drawio
diff --git a/UMLClassDiagram/entity.png → docs/UMLClassDiagram/entity.png b/UMLClassDiagram/entity.png → docs/UMLClassDiagram/entity.png
diff --git a/UMLClassDiagram/entity.svg → docs/UMLClassDiagram/entity.svg b/UMLClassDiagram/entity.svg → docs/UMLClassDiagram/entity.svg
diff --git a/UMLClassDiagram/main.drawio → docs/UMLClassDiagram/main.drawio b/UMLClassDiagram/main.drawio → docs/UMLClassDiagram/main.drawio
diff --git a/UMLClassDiagram/main.png → docs/UMLClassDiagram/main.png b/UMLClassDiagram/main.png → docs/UMLClassDiagram/main.png
diff --git a/UMLClassDiagram/main.svg → docs/UMLClassDiagram/main.svg b/UMLClassDiagram/main.svg → docs/UMLClassDiagram/main.svg
diff --git a/problems/Assignment.pdf → docs/assignments/Assignment.pdf b/problems/Assignment.pdf → docs/assignments/Assignment.pdf
diff --git a/discussions/diagrams/use_case_diagram.pdf → ...discussions/diagrams/use_case_diagram.pdf b/discussions/diagrams/use_case_diagram.pdf → ...discussions/diagrams/use_case_diagram.pdf
diff --git a/discussions/notes.pdf → docs/discussions/notes.pdf b/discussions/notes.pdf → docs/discussions/notes.pdf
diff --git a/discussions/notes.tex → docs/discussions/notes.tex b/discussions/notes.tex → docs/discussions/notes.tex
diff --git a/docs/allclasses-index.html → docs/docs/allclasses-index.html b/docs/allclasses-index.html → docs/docs/allclasses-index.html
diff --git a/docs/allpackages-index.html → docs/docs/allpackages-index.html b/docs/allpackages-index.html → docs/docs/allpackages-index.html
diff --git a/docs/constant-values.html → docs/docs/constant-values.html b/docs/constant-values.html → docs/docs/constant-values.html
diff --git a/docs/copy.svg → docs/docs/copy.svg b/docs/copy.svg → docs/docs/copy.svg
diff --git a/docs/element-list → docs/docs/element-list b/docs/element-list → docs/docs/element-list
diff --git a/docs/help-doc.html → docs/docs/help-doc.html b/docs/help-doc.html → docs/docs/help-doc.html
diff --git a/docs/index-files/index-1.html → docs/docs/index-files/index-1.html b/docs/index-files/index-1.html → docs/docs/index-files/index-1.html
diff --git a/docs/index-files/index-10.html → docs/docs/index-files/index-10.html b/docs/index-files/index-10.html → docs/docs/index-files/index-10.html
diff --git a/docs/index-files/index-11.html → docs/docs/index-files/index-11.html b/docs/index-files/index-11.html → docs/docs/index-files/index-11.html
diff --git a/docs/index-files/index-12.html → docs/docs/index-files/index-12.html b/docs/index-files/index-12.html → docs/docs/index-files/index-12.html
diff --git a/docs/index-files/index-13.html → docs/docs/index-files/index-13.html b/docs/index-files/index-13.html → docs/docs/index-files/index-13.html
diff --git a/docs/index-files/index-14.html → docs/docs/index-files/index-14.html b/docs/index-files/index-14.html → docs/docs/index-files/index-14.html
diff --git a/docs/index-files/index-15.html → docs/docs/index-files/index-15.html b/docs/index-files/index-15.html → docs/docs/index-files/index-15.html
diff --git a/docs/index-files/index-16.html → docs/docs/index-files/index-16.html b/docs/index-files/index-16.html → docs/docs/index-files/index-16.html
diff --git a/docs/index-files/index-17.html → docs/docs/index-files/index-17.html b/docs/index-files/index-17.html → docs/docs/index-files/index-17.html
diff --git a/docs/index-files/index-18.html → docs/docs/index-files/index-18.html b/docs/index-files/index-18.html → docs/docs/index-files/index-18.html
diff --git a/docs/index-files/index-19.html → docs/docs/index-files/index-19.html b/docs/index-files/index-19.html → docs/docs/index-files/index-19.html
diff --git a/docs/index-files/index-2.html → docs/docs/index-files/index-2.html b/docs/index-files/index-2.html → docs/docs/index-files/index-2.html
diff --git a/docs/index-files/index-20.html → docs/docs/index-files/index-20.html b/docs/index-files/index-20.html → docs/docs/index-files/index-20.html
diff --git a/docs/index-files/index-3.html → docs/docs/index-files/index-3.html b/docs/index-files/index-3.html → docs/docs/index-files/index-3.html
diff --git a/docs/index-files/index-4.html → docs/docs/index-files/index-4.html b/docs/index-files/index-4.html → docs/docs/index-files/index-4.html
diff --git a/docs/index-files/index-5.html → docs/docs/index-files/index-5.html b/docs/index-files/index-5.html → docs/docs/index-files/index-5.html
diff --git a/docs/index-files/index-6.html → docs/docs/index-files/index-6.html b/docs/index-files/index-6.html → docs/docs/index-files/index-6.html
diff --git a/docs/index-files/index-7.html → docs/docs/index-files/index-7.html b/docs/index-files/index-7.html → docs/docs/index-files/index-7.html
diff --git a/docs/index-files/index-8.html → docs/docs/index-files/index-8.html b/docs/index-files/index-8.html → docs/docs/index-files/index-8.html
diff --git a/docs/index-files/index-9.html → docs/docs/index-files/index-9.html b/docs/index-files/index-9.html → docs/docs/index-files/index-9.html