Rentify Project

Project Overview

Rentify is a Software as a Service (SaaS) platform designed to revolutionize rental management for small and medium-sized businesses. It offers:

• Real-time inventory tracking
• Secure payment processing
• Automated notifications
• Identity verification
• Customer Relationship Management (CRM)
• Customizable rental store interfaces

This platform aims to simplify and automate rental business processes, enhancing efficiency and customer satisfaction.

---

Project Structure

Rentify/
├── frontend/  # Angular-based frontend application
└── backend/   # Spring Boot-based backend application

---

Tech Stack

• Frontend: Angular
• Backend: Spring Boot
• Database: MySQL
• APIs: Google Maps API, Payment Gateway, Notification API
• Collaboration Tools: GitHub, Notion

---

How to Contribute

1. Clone the Repository

   git clone https://github.com/your-username/Rentify.git
   cd Rentify

2. Set Up the Project

   • Follow the instructions in frontend/README.md and backend/README.md for environment setup.

3. Create a Feature Branch

   • Always create a new branch from develop for any feature or bug fix.

   git checkout develop
   git checkout -b feature/your-feature-name

4. Commit Changes

   • Write meaningful commit messages.

   git commit -m "feat: description of the feature"

5. Push Changes

   git push origin feature/your-feature-name

6. Create a Pull Request to develop

   • Submit your pull request to the develop branch.
   • Aashif (code owner) will review and approve changes.

---

Branching Strategy

• main: Stable production-ready code.
• develop: Integration branch for ongoing development.
• feature/*: Branches for individual features or tasks.
• hotfix/*: Branches for urgent fixes.

---

Pull Request Guidelines

• Ensure code is properly formatted and follows the project’s coding standards.
• Include detailed descriptions in the pull request.
• Pull requests must be reviewed and approved before merging into develop.

---

Weekly Task Completion

• Weekly tasks must be completed and merged into develop by Friday.
• Code reviews will be conducted every Saturday to ensure quality and consistency.
• Unmerged work will be prioritized in the following week.

---

Contact

For any questions or issues, contact Aashif (Project Leader).