ClassMonitor

ClassMonitor is a desktop application for managing your student details. While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).

• If you are interested in using ClassMonitor, head over to the Quick Start section of the User Guide.
• If you are interested about developing ClassMonitor, the Developer Guide is a good place to start.

Acknowledgements

ClassMonitor is a brownfield software project based off AddressBook Level-3, taken under the CS2103T Software Engineering module held by the School of Computing at the National University of Singapore.

Java dependencies:

• Jackson for JSON-related operations
• JavaFX for GUI
• JUnit5 for testing

Documentation dependencies:

• Jekyll for rendering the website
• PlantUML for creating UML diagrams

Fonts used in ClassMonitor:

• ClassMonitor Website:
  • Epilogue by Tyler Finck
  • Source Code Pro by Paul D. Hunt

Other acknowledgments:

• Material Design Icons:
  • star by Sketchify on Canva as ClassMonitor’s App Icon
• Font Awesome 6 icons:
  • book as the “note” admonition icon
  • circle-info as the “info” admonition icon
  • fire-flame-curved as the “danger” admonition icon
  • lightbulb as the “tip” admonition icon
  • triangle-exclamation as the “warning” admonition icon
• Code acknowledgements:
  • Website Layout adapted from AY2223S1-CS2103T-W16-2’s tP Project
  • Custom link fragment checker adapted from the World Wide Web Consortium
  • Pure CSS auto-incrementing heading counters adapted from @gvgramazio on StackOverflow
  • PDF styling of HTML pages following Michael Perrin’s tutorial
  • Pure liquid admonitions adapted from @kimkyunghwan21 on GitHub
  • Pure liquid HTML table-of-contents from @allejo on GitHub
• Miscellaneous:
  • Docusaurus for admonition colors and styling
  • SchemeColor for admonition colors