Lecture Note Sharing Hub Project

The Lecture Note Sharing Hub is a web application designed for the FHNW students to conveniently find and share lecture notes.

It features a comprehensive filtering system that allows students to sort notes by various criteria including location, degree, and module.

Users can upload their notes, manage their content, and easily navigate the platform to access the information they need, tailored to their educational requirements. The app supports secure user authentication for students and admins, ensuring a safe exchange of information.

Scenario

The Lecture Note Sharing Hub is a web application designed for the FHNW students to conveniently find and share lecture notes.

User Stories

User:

As a User, I want to have a website that is easily accessible.
As a User, I want to have a website that is mobile-friendly.
As a User, I want to create an account.
As a User, I want to delete my user account.
As a User, I want to have the opportunity to change my password or username.
As a User, I want to upload my notes for a specific module.
As a User, I want to edit my notes' title and content.
As a User, I want to delete my notes for a specific module if I don’t want to share them anymore.
As a User, I want to favorite notes so I can see how many favorites they have.
As a User, I want an overview of my favorite notes.
As a User, I want to search for notes by title.
As a User, I want to filter notes by location, degree, and module.
As a User, I want to filter notes by module period and module.
As an Admin, I want to delete user accounts.
As an Admin, I want to change usernames for users.
As an Admin, I want to delete notes.
As an Admin, I want to add a module.

Use Case

User:

[Login] User can log into the web application

[View Own Profile] User can view their own profile.

[Change or Delete Own Username or Password] User can change or delete their username or password.

[Upload Notes] User can upload notes.

[View Notes] User can view notes.

[Search, Filter, and Sort Notes] User can search, filter, and sort notes.

[Delete Notes] User can delete their notes.

Admin:

[Login] Admin can log into the web application.

[View Own Profile] Admin can view their own profile.

[Change or Delete Own Username or Password] Admin can change or delete their username or password.

[View User Profiles] Admin can view user profiles.

[Change Usernames from Users] Admin can change usernames for users.

[Delete User Accounts] Admin can delete user accounts.

[Delete Notes] Admin can delete uploaded notes.

Design

The design of the application is based on the official FHNW colors and design principles to ensure consistency with the FHNW websites. The use of a mix of FHNW graphics and custom elements establishes a consistent look and feel. A clean, clear and easily navigable layout provides the user with an intuitive guidance in line with the FHNW's corporate identity guidelines.

Wireframe

Domain Design

Business Logic

Our users are able to filter through all modules of a specific degree. The user is additionally able to search through those degrees via a text search. The following search results are shown accordingly:

If the text matches any of the module titles: The module(s) are listed in the table.
If the text does not match any of the module titles: All modules of the specified degree are shown instead.

Path: ["modules/by-degree/{degreeId}/title?={title}"]

Param: value={degreeId}, Admitted values: Any Integer

Param: value={title}, Admitted values: Any string

Method: GET

Implementation

We used Spring boot for the backend and budibase to build the frontend. The connections were established using a REST API.

Backend Technology

This Web application is relying on Spring Boot and the following dependencies:

To bootstrap the application, the Spring Initializr has been used.

Then, the following further dependencies have been added to the project pom.xml:

<dependency>
			<groupId>com.h2database</groupId>
			<artifactId>h2</artifactId>
			<scope>runtime</scope>
</dependency>

SWAGGER:

   <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
      <version>2.3.0</version>
   </dependency>

Frontend Technology

This Web application was developed using Budibase and it is available for preview at link

Execution

The codespace URL of this Repo is subject to change. Therefore, the Budibase webapp is not going to show any data in the view, when the URL is not updated or the codespace is offline. Follow these steps to start the webservice and reconnect the webapp to the new webservice url.

Clone this repository.
Start your codespace (see video guide at: link)
Run the DemoApplication main available at DemoApplication.java on your own codespace.
Set your app with a public port, see the guide at link.
Create an own Budibase app, you can export/import the existing app. Guide available at link.
Update the URLs in the datasource and publish your app.

Project Management

For our Lecture Note Sharing Hub project, we used a combination of Scrum and Kanban methodologies to ensure efficient and organised project management. This hybrid approach combined the structure of Scrum with the flexibility of Kanban, allowing us to adapt to changes quickly while remaining focused on deliverables.

We organised our work into three sprints, which we planned and tracked with Jira. During each sprint, we prioritised tasks based on their importance and dependencies to ensure that critical functionalities were developed and tested on time. The sprints facilitated iterative progress and allowed us to incorporate feedback and improve continuously.

Sprint 1 concentrated on foundational elements such as user authentication, basic note management features, and initial database and backend infrastructure configuration. Sprint 2 focused on improving the user interface, implementing advanced search and filtering features, and ensuring mobile responsiveness. Sprint 3: Focused on improving the user experience, adding admin features, and conducting extensive testing and bug fixes to ensure a smooth and reliable application. Throughout the project, we used Jira to manage user stories, tasks, and epics, ensuring clear and effective communication among team members.