Rently Bro System Requirements Document

1. Introduction

This document outlines the system requirements for the "Rently Bro" project, which is designed to facilitate monthly rent collection for shops and flats. The system will automate notifications and payments, ensuring efficient and timely transactions.

2. System Overview

Rently Bro is a web-based platform aimed at simplifying the rent collection process for property owners. The system will send automated monthly reminders to tenants and allow them to make payments directly through the website. Additionally, the system will generate receipts for each transaction, providing both the tenant and the owner with a record of payment.

3. Functional Requirements

• As a Property Owner, I should be able to register and list my properties on the platform.
• As a Property Owner, I should be able to set rent amounts and due dates for each property.
• As a Property Owner, I should receive notifications when a tenant makes a payment.
• As a Property Owner, I should be able to view and download payment receipts.
• As a Tenant, I should receive automated monthly reminders about upcoming rent payments.
• As a Tenant, I should be able to make rent payments through the website.
• As a Tenant, I should receive a confirmation and receipt after making a payment.
• As a System, I should automatically send monthly rent reminders to all tenants.
• As a System, I should generate a receipt for each payment transaction.

4. User Personas

• Property Owner: Manages properties, sets rent terms, and receives payments.
• Tenant: Rents a property and makes monthly payments through the platform.

5. Core User Flows

• Property Owner registers -> lists properties -> sets rent terms -> receives payment notifications -> views/downloads receipts.
• Tenant receives reminder -> logs into the website -> makes payment -> receives confirmation and receipt.

6. Visuals Colors and Theme

• primary: #1E3A8A (Deep Blue)
• primary_light: #3B82F6 (Light Blue)
• secondary: #F59E0B (Amber)
• accent: #EF4444 (Red)
• highlight: #FBBF24 (Gold)
• bg: #F3F4F6 (Light Gray)
• surface: rgba(255, 255, 255, 0.8)
• text: #111827 (Dark Gray)
• text_muted: #6B7280 (Muted Gray)
• border: rgba(209, 213, 219, 0.2)

7. Signature Design Concept

The homepage of Rently Bro will feature an interactive 3D cityscape where each building represents a property. Users can click on a building to view property details, payment history, and tenant information. The cityscape will be rendered using @react-three/fiber and @react-three/drei, allowing users to zoom in and out, rotate the view, and explore properties in a dynamic and engaging way. Hovering over a building will display a tooltip with the property's name and rent status, while clicking will open a detailed view with payment options and history.

8. Interaction Model & Motion Direction

The landing page will utilize a "parallax" interaction model, with layered depth effects as users scroll. The 3D cityscape will provide a visually rich first impression, with smooth transitions and animations triggered by user interactions. Internal pages, such as payment and receipt views, will adopt a "static" model for clarity and ease of use.

9. Non-Functional Requirements

• The system must handle concurrent user sessions efficiently.
• Payment processing should be secure and compliant with local regulations.
• The platform should be accessible on both desktop and mobile devices.

10. Tech Stack

• Frontend: React for Web
• Backend: Python, FastAPI
• Database: MySQL or MariaDB, using Alembic for migrations
• AI Tools: Not applicable
• Orchestration: Docker, docker-compose for local development

11. Assumptions and Constraints

• The system assumes users have internet access to receive notifications and make payments.
• Payment gateway integration will be compliant with Indian financial regulations.
• The system will operate in the Indian timezone (IST).

12. Glossary

• Property Owner: An individual or entity that owns rental properties.
• Tenant: An individual or entity that rents a property from the owner.
• Receipt: A document acknowledging that a payment has been made.
• Reminder: An automated notification sent to tenants about upcoming rent payments.