README

Description

Package for real estate and real estate website management, built with Laravel 10+ framework

Requirements

PHP >= 8.1
Laravel >= 10.0
Composer

Compatibility

Laravel	realestatelaravel package
10.x	^2.0
6.x	^1.0

The package only supports the mentioned Laravel versions.

Installation

composer require jeffersonpereira/realestatelaravel

After installing the package, it is necessary to run the command to publish the configuration file.

php artisan realestatelaravel:install

Note:

We strongly advise using environment variables, since when the package install command is executed, the configuration file will be overwritten.

The package has migrations and you will need to run:

php artisan migrate

Important Notes:

When using your template, import assets with the blade directive and cdn for font-awesome.

Note: We use bootstrap 5.1 in our assets

<html>
  <head>
    ...
    <link
      rel="stylesheet"
      href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/all.min.css"
      integrity="sha512-iBBXm8fW90+nuLcSKlbmrPcLa0OT92xO1BIsZ+ywDWZCvqsWgccV3gFoRBv0z+8dLJgyAHIhR35VZc2oM/gI1w=="
      crossorigin="anonymous"
      referrerpolicy="no-referrer"
    />
    @realestatelaravelStyles
  </head>
  <body>
    ...
    <!-- in finishing body -->
    @realestatelaravelScripts
  </body>
</html>

Features available in the package

Property

The package is under development and new features will be added over time. Currently, the package has complete property management functionality.

Routes to views

Use the Menu::class class to get all the view routes to get started when using your template.

use Jeffpereira\RealEstate\Utilities\Helpers\RouteHelper;

$routes = RouteHelper::allView();

Config

Define the configs in your .env

/**
*  Defines whether to use the package `template`
*  -   When set to false, you will need to define a `template` and
*      section_content for the content.
*  .env >> RE_USE_TEMPLATE
*/
'use_template' => true
/**
*  The name of the `template` used to extend the package view - .env >> RE_TEMPLATE
*/
'template' => 'template',
/**
*  Template content section name - .env >> RE_SECTION_CONTENT
*/
'section_content' => 'content',

For more options, check the config/realestatelaravel.php config file

Events

Jeffpereira\RealEstate\Events\BusinessPropertyFinalizedEvent - When the business of the property was finalized

License

Real Estate Laravel is an open source project, licensed by MIT.

jeffersonpereira / realestatelaravel

Maintainers

Details