https://github.com/emoore36/roommate-portal

Full-stack web app with Spring Boot, MongoDB, Thymeleaf, and Spring Security.
https://github.com/emoore36/roommate-portal

bootstrap4 design-patterns full-stack java-application mongodb responsive-design responsive-layout responsive-web-design spring-boot spring-security thymeleaf

Last synced: about 2 months ago
JSON representation

Full-stack web app with Spring Boot, MongoDB, Thymeleaf, and Spring Security.

• Host: GitHub
• URL: https://github.com/emoore36/roommate-portal
• Owner: emoore36
• Created: 2021-04-05T01:43:49.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2023-06-20T22:41:40.000Z (about 3 years ago)
• Last Synced: 2025-01-09T09:27:53.735Z (over 1 year ago)
• Topics: bootstrap4, design-patterns, full-stack, java-application, mongodb, responsive-design, responsive-layout, responsive-web-design, spring-boot, spring-security, thymeleaf
• Homepage:
• Size: 2.98 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# [Roommate Portal](https://roommateportal.herokuapp.com/)

## Introduction

See also: [Project Proposal](documents/CST-451%20Capstone%20Project%20Proposal.docx)

GCU's Student Housing Portal seems to lack a way for students to determine their compatibility as roommates before selecting their housing. This project seeks to simulate an improvement to the existing portal by allowing a user to view other users and their profile information before making housing decisions.

## High-Level Requirements

See also: [Project Requirements](documents/project_requirements.docx)

### Functional

This application supports the following high-level functional requirements

 - Login and Registration

 - User Profile

 - User Questionnaire Response

 - View the Profile and Questionnaire Response of other users

 - In-app Messaging

### Non-functional

 - Spring Security: Users cannot access any pages aside from the login and registration form pages unless logged into the site first.

## Technologies

- MongoDB Atlas (MongoDB v4.2.10) - To compare relational and non-relational databases

- Spring Boot v2.3.5 - To compare the latest in Java frameworks with vanilla Java Spring

- Apache Maven v4.0.0 - To automate the builing of the java application

- GitHub - To store the source code

- Heroku v18 - To deploy the application

- Java Development Kit v11.0.8 - To compare the university-standard Java 8 with a newer version

- Bootstrap v4.5.2 - To add style to the website

- Thymeleaf v3.0.11 - To compare with the use of Apache Tiles and JSPs

- Visual Studio Code v1.49.3

### Best Practices

- All-Caps Database Table Names

- Facade Design Pattern

- IoC / DI Design Pattern

- DAO Design Pattern

- MVC Design Pattern

- N-Layer Design Pattern

### Cloud Deployment

- Application is deployed to Heroku using their integrated GitHub pipeline.

### DevOps principles

- Logging with Logback and SLF4J

- Aspect Interceptor

## New Technologies

New technologies include:

- Spring Boot

- Thymeleaf

- MongoDB

### Reasons for choosing these technologies

I've created vanilla Java Spring applications in the past, but wanted to compare it with the convention-based structure of Spring Boot. Spring Boot is frequently used in the industry, which further drives my incentive to use this framework. The database technology, MongoDB Atlas v4.2.10, allows for fast and flexible documenting of data created by users in the application. Thymeleaf is a popular, more powerful alternative to the use of Apache Tiles with JSPs, so this application serves to compare these two technologies.

## Technical Approach

See also: [Design Specification](documents/CST-451%20Project%20Design%20Submission.docx)

The point of this application is to allow the user to create and sign into an account, create and update their profile, fill out the roommate preferences questionnaire, and view the profiles and questionnaire responses of other users on the website. This is done with a focus on the Spring Boot backend, using MVC and N-Layer design patterns to form the structure of the application. The user data will be contained in a MongoDB Cluster using MongoDB Atlas, an online application which serves as a cloud database service. Inversion of Control and Dependency Injection are also used in this application to allow for increase code interchangeability.

### Diagrams

- Class UML example:

Questionnaire Response Functionality

![Application Class UML - Questionnaire Response Functionality](diagrams/classUML-QuestionnaireResponse%20Functionality.png)

- Sitemap:

![Application Sitemap](diagrams/site_map.png)

- Logical Diagram:

![Application Logical Diagram](diagrams/project_proposal_block_diagram.png)

## Risks and Challenges

- Unfamiliar with Spring Boot

- Unfamiliar with MongoDB

- Unfamiliar with Thymeleaf

- Unfamiliar with Spring Security

- Unfamiliar with Visual Studio Code

### Resources for overcoming R&Cs

- Developed Proofs of Concept (POCs) for unfamiliar technologies

- Referenced documentation sources

  - [Spring Boot, Spring Security](https://spring.io/guides)

  - [MongoDB](https://docs.mongodb.com/manual/)

  - [Thymeleaf](https://www.thymeleaf.org/documentation.html)

  - [Visual Studio Code](https://code.visualstudio.com/docs)

- Referenced technical resource guides from sites including:

  - [Mkyong](https://mkyong.com/)

  - [Baeldung](https://www.baeldung.com/)

  - [DZone](https://dzone.com/)

### Risk Management Approaches

- Developing Proofs of Concept

## Outstanding Issues

- Bugs:

  - Search bar in DisplayAllUsers page does not filter users

  - Spring Security removes line breaks and indentation in messages and replies.