Project Proposal

Overview

We are proposing to create a flat management for solving common renting issues such as splitting and managing bills and facilitating communication between renters and property managers.

Features

Initial Scope

• Bill/purchase management
• Split tasks like taking the rubbish out - Chore management
• Move in and Move out the schedule
• WiFi Passwords

Potential Future Scope

• Landlord communication
• Maintenance/Repairs - Documentation of complaints/issues and similar stuff
• Fair rent split based on room information(rent calculator) Rent Calculator :: Splitwise
• Could add something like amenities provided by the flat (AirBnB ish)
• Status - i.e. out of the house on certain dates
• User Registration/Authentication
• Disputes Tribunal Integration & Tenancy advice
• Calendar integration/WebCal
• Shared wiki-like text

Out of Scope

• Venmo kinda thing to share $ between flatmates for groceries etc
• Add “looking for flatmates” search
• Landlord/House Ratings
• Rate flatmates

Specifications

Milestones

• Setting up project structure and get the initial app running
  • Setting up dev environment (docker)
  • React app with routing
  • Capable of communicating with API
  • Endpoints set up
  • Deadline: 2022-03-07
• Account management. Login and user creation
  • User can create an account/flat group
  • User can login, logout
  • edit user details
• Bill/Purchase management - MVP
  • Users can add/manage bills incl recurring
  • Users can mark as paid

Proposed Technologies

The proposed technology is a web application with the following stack:

Backend

Database: Mongodb (mongoose)
Application: NestJS
Language: NodeJS 16 (Typescript)
API Type: REST
Firebase Authentication

Frontend

Create-React-App or plain typescript w/ webpack
Tailwind, HeadlessUI or NextUI