/Flattered

Web application to support peaple living in a shared flat organizing their daily tasks and finances in one tool.

Primary LanguageJava

Flattered Logo

Introduction

Flattered is a web application developed for people living in shared flats. It is designed to support them to manage their flats and members of it. The grocery list for a flat can also be filled, checked, edited and updated. The user creating a flat automatically gets assigned the admin role. This particular user only is in charge of editing or deleting the flat, as well as inviting other users by using the unique access token. If a user is assigned to multiple flats or the dashboard displays a “No Flat” message, the user will have to switch his current flat by selecting it in the “switch active flat” dropdown in the dashboard.

Installation

What you need to:

  • Host this application:
    • Install IntelliJ Ultimate (download IntelliJ here, you need a licence to use IntelliJ).
    • Install Tomcat Application Server (we recommend installing Tomcat 9.0).
    • Install JAVA:
      • Java JDK (Java Development Kit).
      • Do not install Java Runtime Environment (JRE) of version 1.8 or higher.
    • We recommend installing OpenJDK 15. The installation files can be found here.
    • Install MySQL:
      • MySQL Database Server 5.7 (Community Edition).
      • MySQL Workbench.
    • Set up the Database
      • Create a schema named flattered.
      • Create a user named flattered with the password flattered.
      • Give the user flattered all privileges for the flattered schema.
      • You might need to set the Timezone to your current one.
    • Save the application files and open the project folder in IntelliJ, then run the application.
  • Access the website:
    • An up to date web browser, we recommend using Mozilla Firefox or Google Chrome.

Technical Requirements

  • Tomcat Webserver
  • MySql Server
  • IntelliJ
  • Java 15

Team Members

Name GitHub Responsibilities
CEH Maximilian @W0M34T Flats, Security, Files, Code Reviews
DWORACEK Lukas @dwori GitHub Repository, Manage pull requests, Grocery Items, Flats, Code Reviews
GANSTER Peter @Giu52 Design, Security, Files, Code Reviews

Project Proposal & Repository

Project Proposal

GitHub Repository