Proper Properties

Proper Properties Application

Real Estate is a web-based application that allows users to rent or buy properties from a variety of locations around the world. Users can search for properties based on their desired location and rental dates, view available options, and book their rental directly through the application.

Built With

Proper Properties is built with modern web technologies, including Next.js for server-rendered React, Tailwind for custom CSS, and Redux Toolkit for managing application state. It also integrates with external platforms like Stripe for payment processing, Cloudinary for image management, and MongoDB for data storage. Finally, NextAuth is used to handle user authentication and authorization:

• Next.js is a framework for building server-rendered React applications. It allows developers to build web applications that are optimized for performance and SEO, with automatic code splitting and optimized server-side rendering.
• Chakra UI is a utility-first CSS framework that allows developers to quickly build custom designs by composing pre-defined CSS classes. It provides a wide range of low-level styles that can be combined in various ways to create complex layouts and designs.
• Express is a web application framework for Node.js that provides a simple and flexible way to build web applications and APIs. It includes a range of features for routing, middleware, and error handling.
• NextAuth is a library for adding authentication to Next.js applications. It provides a simple and flexible way to implement user login, registration, and authorization in a Next.js app.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• git

  If you want to clone the project from GitHub and work with it locally, you will need to have Git installed on your system. You can download and install Git from the official website (https://git-scm.com/).

• Node.js

  Application requires Node.js to be installed on your system in order to run. You can download and install the latest version of Node.js from the official website (https://nodejs.org/).

• npm (Node Package Manager)

  npm is the package manager for Node.js, and is used to manage the dependencies and packages required for your Next.js project. It is installed automatically when you install Node.js.

  To check if npm is installed on your system, you can open a terminal or command prompt and enter the following command:

  npm -v

Once you have these prerequisites in place, you can proceed to clone the project from GitHub using Git.

Installing

Make sure you have all the necessary prerequisites installed on your system. Follow the below steps to install the setup the project on your machine:

• Open a terminal or command prompt and navigate to the directory where you want to clone the project.

• Run the following command to clone the project from GitHub:

  git clone https://github.com/t-creates/tg-realestate.git

• This will create a new directory called "tg-realestate" in the current location, containing the code for the Proper Properties project.

• Navigate to the project directory by running the following command:

  cd tg-realestate

• Run the following command to install the project's dependencies using npm:

  npm install

• To use the Proper Properties project, you will need to set up some environment variables on your development machine. Here are the steps to follow:

  1. Create a .env file in the root of the project.
  2. Add the following variables to the .env file, replacing the placeholder values with your own:

  STRIPE_SECRET_KEY=<your-stripe-secret-key>
  
  MONGODB_URI=<your-mongodb-uri>
  SESSION_SECRET=<your-session-secret>

  1. Save the .env file.

  These environment variables are required for various aspects of the project, such as payment processing with Stripe, image management with Cloudinary, and database connectivity with MongoDB. Be sure to replace the placeholder values with your own values that you obtained from the respective services.

• Once the dependencies are installed, you can run the project locally by running the following command:

  npm start

This will start the development server and open the Proper Properties application in your default web browser.

Features

• Property Search: Search for a properties to rent or buy based on various criteria, such as location, availability, and type of property.
• Property availability: Display the availability of properties in real-time, so users can quickly determine which options are currently available for rent.
• Property details: View detailed information about the properties available for rent or buy, including make and rooms, features, and pricing.
• Account management: Create and manage their own profiles within the app, including the ability to save payment information and rental preferences.

Contributing

We welcome contributions to Proper Properties! If you have an idea for a new feature, an improvement to an existing feature, or a bug fix, please open an issue to discuss it before submitting a pull request. This helps me to review and understand your changes more efficiently.

To contribute code to Proper Properties:

1. Fork the repository
2. Create a new branch for your feature or bug fix
3. Commit your changes to the new branch
4. Run the automated tests to ensure that your changes do not break any existing functionality
5. Open a pull request back to the main repository, including a description of your changes and any relevant issue numbers

Please make sure that your code follows the coding style and standards used in the rest of the project. We also ask that you write tests for your changes, to ensure that they are robust and reliable.

Thank you for your contribution to Proper Properties! We appreciate your efforts to help make this a great car renting application.