https://github.com/muchokidavid/mtaani-fe
MtaaniApp is a comprehensive property management system built with React for the frontend. It is designed to streamline property management for landlords and tenants, offering features like tenant and landlord management, property and room management, maintenance requests, complaints, announcements, and more.
https://github.com/muchokidavid/mtaani-fe
Last synced: 10 months ago
JSON representation
MtaaniApp is a comprehensive property management system built with React for the frontend. It is designed to streamline property management for landlords and tenants, offering features like tenant and landlord management, property and room management, maintenance requests, complaints, announcements, and more.
- Host: GitHub
- URL: https://github.com/muchokidavid/mtaani-fe
- Owner: MuchokiDavid
- License: mit
- Created: 2025-02-21T10:58:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-18T19:41:52.000Z (over 1 year ago)
- Last Synced: 2025-09-02T10:42:30.274Z (10 months ago)
- Language: JavaScript
- Homepage: https://mtaani-fe.vercel.app
- Size: 568 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MtaaniApp - Property Management System
MtaaniApp is a comprehensive property management system built with **React** for the frontend. It is designed to streamline property management for landlords and tenants, offering features like tenant and landlord management, property and room management, maintenance requests, complaints, announcements, and more.
---
## Features
### User Management
- **Custom User Model**: Supports roles for tenants, landlords, and admins.
### Tenant Management
- **Tenant Profiles**: Manage tenant details, leases, and payment history.
- **Room Booking**: Tenants can book available rooms.
- **Maintenance Requests**: Tenants can submit maintenance requests for their rooms or properties.
- **Complaints**: Tenants can file complaints regarding property issues.
- **Feedback**: Tenants can provide feedback on their experience.
### Landlord Management
- **Property Management**: Add, update, and manage properties with details like name, location, and description.
- **Room Management**: Manage rooms within properties, including availability and pricing.
- **Announcements**: Post announcements for tenants (e.g., maintenance schedules, policy updates).
- **Payment Tracking**: Track payments from tenants for booked rooms or properties.
### Admin Features
- **Dashboard**: Admin panel to manage users, properties, payments, and system-wide settings.
- **Notifications**: Send notifications to users for important updates.
---
## Technologies Used
### Frontend
- **Framework**: React Vite
- **State Management**: React Context API or Redux (optional)
- **Styling**: Tailwind CSS or any CSS framework
- **Routing**: React Router
- **Data storage** : IndexedDb
---
## Installation
### Frontend Setup (React)
1. **Navigate to the frontend directory**:
```bash
cd ../mtaani-fe
```
2. **Install dependencies**:
```bash
npm install
```
3. **Run the frontend server**:
```bash
npm run dev
```
The frontend will be available at `http://localhost:3000`.
---
## Usage
### Tenant Features
- **Register/Login**: Tenants can register or log in to access their dashboard.
- **Book a Room**: Browse available rooms and book them.
- **Submit Maintenance Requests**: Report issues with their room or property.
- **File Complaints**: Submit complaints regarding property issues.
- **View Announcements**: Stay updated with announcements from landlords.
### Landlord Features
- **Register/Login**: Landlords can register or log in to access their dashboard.
- **Manage Properties**: Add, update, or delete properties.
- **Manage Rooms**: Add or update rooms within properties.
- **Post Announcements**: Share updates or notices with tenants.
---
## Contributing
We welcome contributions! If you'd like to contribute to MtaaniApp, follow these steps:
1. **Fork the repository**.
2. **Create a new branch**:
```bash
git checkout -b feature-name
```
3. **Make your changes**.
4. **Commit your changes**:
```bash
git commit -am 'Add new feature'
```
5. **Push to your branch**:
```bash
git push origin feature-name
```
6. **Create a Pull Request**.
---
## License
This project is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for details.
---
## Contact
For questions, suggestions, or support, feel free to reach out:
- **Email**: [dmmuchoki7@gmail.com]
- **GitHub Issues**: [Open an issue](https://github.com/muchokidavid/mtaani-fe/issues)
---
Thank you for using MtaaniApp! We hope it simplifies property management for you. 🏠✨