https://github.com/rahul8320/rentify
Searching property made easy.
https://github.com/rahul8320/rentify
dotnet-framework identity-framework jwt-token logging react react-hook-form typescript
Last synced: 3 months ago
JSON representation
Searching property made easy.
- Host: GitHub
- URL: https://github.com/rahul8320/rentify
- Owner: Rahul8320
- Created: 2024-06-02T03:18:48.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-11T08:13:01.000Z (about 2 years ago)
- Last Synced: 2025-07-30T07:55:56.550Z (11 months ago)
- Topics: dotnet-framework, identity-framework, jwt-token, logging, react, react-hook-form, typescript
- Language: C#
- Homepage:
- Size: 212 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Rentify
[]()
[](https://github.com/Rahul8320/Rentify/issues)
[](https://github.com/Rahul8320/Rentify/pulls)
[](/LICENSE)
---
Searching property made easy.
## 📝 Table of Contents
- [About](#about)
- [Features](#features)
- [Technologies](#technologies)
- [Getting Started](#getting_started)
- [Running the tests](#tests)
- [Usage](#usage)
- [Deployment](#deployment)
- [Built Using](#built_using)
- [Authors](#authors)
- [Acknowledgments](#acknowledgement)
This project provides a robust and scalable platform for property search, enabling buyers to find their dream homes and sellers to effortlessly list their properties.
- **Property Search:**
- Buyers can search for properties based on various criteria, including:
- Number of bedrooms
- Location (including search by radius or specific addresses)
- Nearby places (e.g., schools, parks, restaurants)
- Enhanced search experience with user-friendly filtering and sorting options.
- **Property Listing:**
- Sellers can register and log in to the system.
- Sellers can add new properties with detailed descriptions, photos, and relevant information.
- **Authentication and Authorization:**
- Secure user authentication using ASP.NET Core Identity Server.
- Role-based access control (RBAC) to restrict unauthorized actions.
**Backend:**
- ASP.NET Core: A robust and flexible framework for building web APIs.
- Identity Server: Secure user authentication and management.
- CQRS Pattern: Efficient handling of read and write operations for improved scalability.
- Serilog: Comprehensive and structured logging for better application monitoring.
- In-Memory Caching: Caching frequently accessed data for faster performance.
**Frontend:**
- React: A popular JavaScript library for building dynamic and user-friendly interfaces.
- TypeScript: Typed JavaScript extension for enhanced code maintainability and catch errors early.
- Redux (or Context API): State management solution for managing application state in the frontend (replace with your chosen library).
- React Hook Form: Efficient form handling and validation.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.
### Prerequisites
- .NET Core SDK (https://dotnet.microsoft.com/en-us/download)
- .NET CLI & EF Core Tools (https://learn.microsoft.com/en-us/ef/core/cli/dotnet)
- Node.js and npm (https://nodejs.org/en/about/previous-releases)
### Installing
**Backend:**
- Clone the repository.
- Navigate to the backend directory.
- Restore NuGet packages:
```
dotnet restore
```
- Run migrations to create database schema:
```
dotnet ef migrations
```
- Apply migrations:
```
dotnet ef database update
```
- Start the backend API:
```
dotnet run --project .\Rentity.Api\
```
**Frontend:**
- Navigate to the frontend directory.
- Install dependencies:
```
npm install
```
- Start the development server:
```
npm run dev
```
Explain how to run the automated tests for this system.
### Break down into end to end tests
Explain what these tests test and why
```
Give an example
```
### And coding style tests
Explain what these tests test and why
```
Give an example
```
- This README provides a high-level overview. Refer to the project's code and documentation for detailed implementation details.
- Implement unit and integration tests for robust code quality.
- Explore containerization with Docker for easier deployment and scalability.
Add additional notes about how to deploy this on a live system.
- [Sqlite](https://www.sqlite.org/index.html) - Database
- [ASP.NET Core](https://dotnet.microsoft.com/en-us/apps/aspnet) - Backend Framework
- [Serilog](https://serilog.net/) - Structured Logging
- [ReactJs](https://react.dev/) - Web Framework
- [React Hook Form](https://react-hook-form.com/) - Forms Validation
- [Shadcn](https://ui.shadcn.com/) - Component Library
- [Tailwindcss](https://tailwindcss.com/) - CSS Library
- [@Rahul8320](https://github.com/Rahul8320) - Idea & Initial work
See also the list of [contributors](https://github.com/kylelobo/The-Documentation-Compendium/contributors) who participated in this project.
- Hat tip to anyone whose code was used
- Inspiration
- References