This repository contains the template for the CSE project. Please extend this README.md with sufficient instructions that will illustrate for your TA and the course staff how they can run your project.
To run the template project from the command line, you either need to
have Maven installed on your local system (mvn) or you need to use the Maven
wrapper (mvnw). You can then execute
mvn clean install
to package and install the artifacts for the three subprojects. Afterwards, you can run ...
cd server
mvn spring-boot:run
to start the server or ...
cd client
mvn javafx:run
to run the client. Please note that the server needs to be running, before you can start the client.
- All basic requirements have been implemented.
- Multi-Collection
- Interconnected Content
- Live Language Switch
- Supported languages: English, Dutch, German, Spanish, and Polish (uses Unicode for sepcial characters).
- Color Contrast
- Keyboard Shortcuts
- Multi-modal Visualization
- Logical Navigation
- Keyboard Navigation
Note we did NOT implement
Undo Actions.
- Error Messages
- Informative Feedback
- Confirmation for Key Actions
ESC: Focus on the search barCtrl + N: Add a new noteCtrl + up/down arrows: Navigate notes up and downCtrl + left/right arrows: Navigate collections left and right
- client.scenes: Contains all JavaFX controllers
config: Configuration for saving settings between runs- Multiple controller classes for different functionalities (AddCollection, AddNote, etc.)
- client.resources: Contains the visual elements and FXML views of the UI
- Shared data models (Note, NoteCollection, NoteTag)
- server.api: REST controllers for note management
- NoteController, NoteCollectionController, TagController
- server.database: Repository layer for data persistence
- server.service: Business logic layer
- Includes Markdown service