Welcome to the RealState repository! This project is a modern, full-featured property management dashboard designed to simplify your property management tasks. Built with a robust tech stack, RealState offers a seamless user experience for property managers, landlords, and tenants alike.
- User-Friendly Interface: The dashboard provides an intuitive layout that makes property management straightforward.
- Property Listings: Easily add, edit, and manage property listings.
- Tenant Management: Keep track of tenants, their details, and lease agreements.
- Analytics Dashboard: Gain insights into property performance with visual data representations.
- Responsive Design: Access the dashboard from any device, ensuring flexibility and convenience.
RealState is built using a variety of modern technologies:
- Next.js: For server-side rendering and static site generation.
- React: The core library for building user interfaces.
- TypeScript: Adds static typing to JavaScript, improving code quality.
- Redux: Manages the application state effectively.
- Tailwind CSS: Provides utility-first CSS for fast styling.
- PostCSS: For transforming CSS with JavaScript plugins.
- Zod: A TypeScript-first schema declaration and validation library.
- Recharts: For building charts and visual data representations.
- Embla Carousel: A lightweight carousel library.
- Lucide React: For customizable icons.
- Sonner: A notification library for user feedback.
- clsx: A utility for constructing className strings.
- cmdk: A command menu for enhanced user interactions.
To set up the RealState project locally, follow these steps:
-
Clone the Repository:
git clone https://github.com/mohitttailor023/RealState.git cd RealState -
Install Dependencies: Make sure you have Node.js installed. Then run:
npm install
-
Run the Development Server: Start the server with:
npm run dev
Open your browser and navigate to
http://localhost:3000to see the application in action.
After setting up the project, you can start managing properties right away. Here are some key functionalities:
- Add Property: Use the "Add Property" button on the dashboard to input details about new properties.
- Manage Tenants: Navigate to the "Tenants" section to view, add, or update tenant information.
- View Analytics: Access the analytics dashboard to see charts and graphs representing property performance.
For a detailed guide on each feature, refer to the documentation provided in the docs folder.
We welcome contributions to enhance RealState. If you wish to contribute, please follow these steps:
- Fork the Repository: Click on the "Fork" button at the top right corner of the page.
- Create a Branch:
git checkout -b feature/YourFeatureName
- Make Your Changes: Implement your feature or fix.
- Commit Your Changes:
git commit -m "Add your message here" - Push to Your Branch:
git push origin feature/YourFeatureName
- Open a Pull Request: Go to the original repository and click on "New Pull Request".
This project is licensed under the MIT License. See the LICENSE file for more details.
For the latest updates and versions, visit the Releases section. You can download the latest version and execute it for your needs.
To keep track of new features and improvements, make sure to check the releases regularly.
We appreciate all the contributors and the open-source community for their support and resources that helped in building RealState.
For any inquiries or feedback, feel free to reach out through the GitHub Issues section or contact the maintainers directly.
This README serves as a comprehensive guide to understanding and using the RealState property management dashboard. For any further assistance, please check the documentation or raise an issue on GitHub.