forked from Anjaliavv51/Retro
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request Anjaliavv51#106 from SumanKisku/improve-readme
FIX: Improve the design of readme file and add contributors section. Anjaliavv51#53
- Loading branch information
Showing
1 changed file
with
108 additions
and
76 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,76 +1,108 @@ | ||
| # Rentalog - Rent Management Web App For Landlords | ||
| <p>Rentalog is a web application that makes it easy for landlords to manage their rental properties. With Rentalog, landlords can keep track of important information about their renters, including their names, addresses, and rental payment history. This information is stored in a secure and organized manner, so landlords can access it whenever they need to. In addition to keeping track of renters' information, Rentalog also makes it easy for landlords to collect and track monthly rent payments. This way, landlords always know exactly how much money they're earning from their properties and can make informed decisions about their business. Using Rentalog is simple and straightforward. All of the information is organized in a user-friendly interface, so landlords can access what they need quickly and easily. And, if they ever have questions or need help, they can reach out to Rentalog's dedicated support team for assistance. Overall, Rentalog is a convenient and efficient tool for landlords who want to keep their rental business organized and running smoothly.</p> | ||
| <h2>Features</h2> | ||
| <ul> | ||
| <li><strong>Tenant management:</strong> Keep track of important information about your renters, such as their names, addresses, and rental payment history.</li> | ||
| <li><strong>Rent collection:</strong> Collect and track monthly rent payments easily.</li> | ||
| <li><strong>Rent calculations:</strong> Automatically calculate the total rent received each month and see a breakdown of payments.</li> | ||
| <li><strong>Property listing:</strong> Showcase your rental properties and attract potential tenants by listing them on Rentalog.</li> | ||
| <li><strong>User-friendly interface:</strong> Easy to use and navigate.</li> | ||
| <li><strong>Dedicated support team:</strong> Available to help landlords with any questions or problems they may have.</li> | ||
| </ul> | ||
| <h2>Current Version Tech stack</h2> | ||
| <p>Rentalog is built using the following technologies:</p> | ||
| <ul> | ||
| <li>HTML</li> | ||
| <li>CSS</li> | ||
| <li>JavaScript</li> | ||
| <li>Bootstrap</li> | ||
| <li>Node.js</li> | ||
| <li>Express.js</li> | ||
| <li>Embedded JavaScript (EJS)</li> | ||
| <li>MongoDB</li> | ||
| <li>Mongoose</li> | ||
| <li>Passport.js</li> | ||
| </ul> | ||
| <h2>Now we want contributions on the migration of the Rentalog's tech stack to React js and Next js</h2> | ||
| <p>The migration to React.js and Next.js offers several advantages for Rentalog:</p> | ||
| <ul> | ||
| <li><strong>Performance Boost:</strong> React.js enables efficient rendering and updates, resulting in a snappier and more responsive user interface.</li> | ||
| <li><strong>Enhanced User Experience:</strong> With React.js, we can build interactive components that provide a seamless and engaging experience for our users.</li> | ||
| <li><strong>Code Maintainability:</strong> React.js promotes a component-based architecture, making the codebase modular, reusable, and easier to maintain.</li> | ||
| <li><strong>Server-side Rendering:</strong> Next.js introduces server-side rendering, leading to faster initial page loads and improved search engine optimization (SEO).</li> | ||
| <li><strong>Scalable State Management:</strong> React.js, combined with libraries like Redux or React Context, provides efficient state management for handling complex application states</li> | ||
| <li><strong>Rich Ecosystem:</strong> Migrating to React.js and Next.js opens up a vast ecosystem of tools, libraries, and community support for future development and enhancements. | ||
| </li> | ||
| </ul> | ||
| <h2>How to Contribute</h2> | ||
| <p>We welcome contributions from the open-source community to help with the migration of Rentalog's tech stack to React.js and Next.js. Here's how you can contribute:</p> | ||
| <ol> | ||
| <li>Fork the repository by clicking the "Fork" button in the upper right corner of this page.</li> | ||
| <li>Clone your forked repository to your local machine:<br> | ||
| <code>git clone https://github.com/gauravsingh1281/Rentalog-Rent-Management-Web-App-For-Landlords.git</code> | ||
| </li> | ||
| <li>Install project dependencies:<br> | ||
| <code>npm install | ||
| </code> | ||
| </li> | ||
| <li>Create a new branch for your contribution:<br> | ||
| <code>git checkout -b your branch name | ||
| </code> | ||
| </li> | ||
| <li>Begin migrating components and features to React.js and Next.js, adhering to best practices and code conventions.</li> | ||
| <li>Test your changes locally to ensure they function correctly.</li> | ||
| <li>Commit your changes with descriptive commit messages:<br> | ||
| <code>git commit -m "Commit message"</code> | ||
| </li> | ||
| <li>Push your changes to your forked repository:<br> | ||
| <code>git push origin your branch name</code> | ||
| </li> | ||
| <li>Open a pull request to the <strong>main</strong> branch of this repository.</li> | ||
| <li>If you find any bugs or have any suggestions, please open an issue on GitHub and provide detailed information about the bug or suggestion.</li> | ||
| </ol> | ||
| <p>Once your pull request is submitted, it will be reviewed by the project maintainers. Feedback and suggestions for further improvements may be provided. Thank you for contributing to the migration of Rentalog's tech stack to React.js and Next.js!</p> | ||
| <h2>Inspiration Links</h2> | ||
| <ul> | ||
| <li><strong>Figma Design:</strong> Explore the Figma design for the new version of Rentalog <a href="https://www.figma.com/file/9WhtUQT7s5ogTiDTp90PxI/RENTALOG-WEB-DESIGN?type=design&node-id=0-1&mode=design&t=ZNeyPXk16TlWB6I6-0">here</a>.</li> | ||
| <li><strong>Current Tech Stack:</strong> If you're interested in exploring the current tech stack used in the older version of Rentalog, you can visit the <a href="https://rentalog-web-app.azurewebsites.net/">Rentalog.in</a> and use its functionality as a reference while migrating to React.js and Next.js.<br> | ||
| <p>Rentalog Demo Account Credentials</p> | ||
| <ul type="square"> | ||
| <li>Username - [email protected]</li> | ||
| <li>Password - @1a2b3c4d5E</li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| <h2>License</h2> | ||
| <p>Rentalog is released under the <strong>MIT License</strong>. By contributing to this project, you agree to provide your contributions under the same license.</p> | ||
| # Rentalog - Rent Management Web App For Landlords 🏠 | ||
|
|
||
| Rentalog is a user-friendly web application designed to simplify the management of rental properties for landlords. With Rentalog, landlords can effortlessly keep track of crucial tenant information, such as names, addresses, and rental payment history. This data is securely and neatly organized, ensuring landlords have easy access whenever they need it. | ||
|
|
||
| In addition to tenant management, Rentalog streamlines rent collection, making it a breeze for landlords to keep tabs on monthly payments. This enables landlords to maintain a clear understanding of their rental income, facilitating informed business decisions. | ||
|
|
||
| ## 🚀 Features | ||
|
|
||
| - **Tenant Management** 💼: Seamlessly organize tenant details, including names, addresses, and rental payment history. | ||
| - **Rent Collection** 💸: Collect and monitor monthly rent payments with ease. | ||
| - **Rent Calculations** 📊: Automatically calculate total monthly rent received and view payment breakdowns. | ||
| - **Property Listing** 🏘️: Showcase your rental properties and attract potential tenants through Rentalog listings. | ||
| - **User-friendly Interface** 🧑🏻🦳: Intuitive and easy-to-navigate interface for quick access to information. | ||
| - **Dedicated Support Team** 📲: Reach out to Rentalog's support team for assistance and guidance. | ||
|
|
||
| ## 📦 Current Version Tech Stack | ||
|
|
||
| Rentalog is built using the following technologies: | ||
|
|
||
| - React ⚛️ | ||
| - Tailwind 🎨 | ||
| - Node.js ⚙️ | ||
| - Express.js 🚀 | ||
| - Embedded JavaScript (EJS) 🌐 | ||
| - MongoDB 📦 | ||
| - Mongoose 📦 | ||
| - Passport.js 🔐 | ||
|
|
||
| ## 🛠️ Migration to React.js and Next.js | ||
|
|
||
| We are now seeking contributions for the migration of Rentalog's tech stack to React.js and Next.js. This migration offers several advantages: | ||
|
|
||
| - **Performance Boost 🚀**: React.js enables efficient rendering and updates, resulting in a snappier and more responsive user interface. | ||
| - **Enhanced User Experience 🌟**: Interactive components can be built, providing a seamless and engaging user experience. | ||
| - **Code Maintainability 🔧**: React.js promotes a component-based architecture, making the codebase modular, reusable, and easier to maintain. | ||
| - **Server-side Rendering 🌐**: Next.js introduces server-side rendering, leading to faster initial page loads and improved SEO. | ||
| - **Scalable State Management 📈**: React.js, combined with libraries like Redux or React Context, offers efficient state management. | ||
| - **Rich Ecosystem ⚙️**: Migration opens up a vast ecosystem of tools, libraries, and community support for future development and enhancements. | ||
|
|
||
| ## 🤝 How to Contribute | ||
|
|
||
| We welcome contributions from the open-source community to assist with the migration. Here's how you can get involved: | ||
|
|
||
| #### ***Found an issue on our app?*** | ||
|
|
||
| **Raise an issue:** You can raise an issue for that. And our smart contributers will fix that issue for you. | ||
|
|
||
| #### ***Have a feature idea in your mind?*** | ||
|
|
||
| You can propose a feature by raising an issue. But before that make sure the feature isn't proposed already in **OPEN** or **CLOSED** issues. | ||
|
|
||
| ### ***Want to contribute by coding?*** | ||
|
|
||
| 1. **Fork:** Star the repository and then fork the repository by clicking the "Fork" button in the upper right corner of this page. | ||
| 2. **Clone:** your forked repository to your local machine: | ||
| ``` | ||
| git clone https://github.com/your-username/Rentalog-Rent-Management-Web-App-For-Landlords.git | ||
| ``` | ||
| 4. **Enter the source directory:** | ||
| 5. ``` | ||
| cd Rentalog-Rent-Management-Web-App-For-Landlords | ||
| ``` | ||
| 8. **Install project dependencies:** | ||
| 9. ``` | ||
| npm install | ||
| ``` | ||
| 11. **Create a new branch for your contribution:** | ||
| ``` | ||
| git checkout -b your-branch-name | ||
| ``` | ||
| 14. Begin migrating components and features to React.js and Next.js, adhering to best practices and code conventions. | ||
| 15. **Start Development Server:** To test your changes locally to ensure they function correctly. | ||
| ``` | ||
| npm run dev | ||
| ``` | ||
| 17. **Commit:** your changes with descriptive commit messages: | ||
| ``` | ||
| git commit -m "Commit message" | ||
| ``` | ||
| 18. **Push:** your changes to your forked repository: | ||
| ``` | ||
| git push origin your-branch-name | ||
| ``` | ||
| 20. **Open a PR:** to the **main** branch of this repository. | ||
| Once your pull request is submitted, it will be reviewed by the project maintainers. Feedback and suggestions for further improvements may be provided. Thank you for contributing to the migration of Rentalog's tech stack to React.js and Next.js! | ||
| **Rentalog Demo Account Credentials**: | ||
| - Username: <[email protected]> | ||
| - Password: @1a2b3c4d5E | ||
| ## 🔗 Inspiration Links | ||
| - **Figma Design**: Explore the Figma design for the new version of Rentalog [here](https://www.figma.com/file/9WhtUQT7s5ogTiDTp90PxI/RENTALOG-WEB-DESIGN?type=design&node-id=0-1&mode=design&t=ZNeyPXk16TlWB6I6-0). | ||
| - **Current Tech Stack**: To explore the current tech stack used in the older version of Rentalog, visit [Rentalog.in](https://rentalog-web-app.azurewebsites.net/). Use its functionality as a reference while migrating to React.js and Next.js. | ||
| ## 📄 License | ||
| Rentalog is released under the **MIT License**. By contributing to this project, you agree to provide your contributions under the same license. | ||
| ## ✨ Contributors | ||
| All Thanks to our contributors 💙 | ||
| [](https://github.com/gauravsingh1281/Rentalog-Rent-Management-Web-App-For-Landlords/graphs/contributors) | ||
| Feel free to join our team and contribute to making Rentalog even better! 🚀 |