🛠️Installation

Welcome to the installation guide for Eazy, the Laravel-powered platform for booking unique vacation rentals! This guide will equip you with the steps to set up a development environment and get Eazy

Requirements:

Please read the requirements Section of the documentation Requirements

Installation Steps (Backend):

  1. Download the Application:

    Log in to your account and download the Eazy Laravel application files. You'll typically receive a ZIP archive.

  2. Extract the Files:

    Extract the downloaded ZIP archive to a desired location on your development machine. This will create the Eazy application directory.

  3. Navigate to Project Directory:

    Open your terminal and navigate to the extracted directory using the cd command:

    Bash

    cd Eazy/backend
  4. Install Application Dependencies:

    Composer manages the application's third-party libraries. Run the following command to install them:

    Bash

    composer install
  5. Generate Application Key:

    A secret application key is essential for security. Run the following command to generate one:

    Bash

    php artisan key:generate

    Use code with caution.content_copy

    This will create a new application key and store it in the .env environment file.

  6. Configure Database Connection:

    The .env file holds various configuration settings. Open it in a text editor and locate the database connection details. Update them with your specific database credentials:

    DB_CONNECTION=mysql
    DB_HOST=your_database_host
    DB_PORT=3306  # Adjust if your database port differs
    DB_DATABASE=your_database_name
    DB_USERNAME=your_database_username
    DB_PASSWORD=your_database_password

    Replace the placeholders with your actual database information. Make sure you have a MySQL database set up and ready to use.

  7. Migrate and Seed Database (Optional):

    This step creates the database tables and optionally populates them with sample data for testing purposes:

    Bash

    php artisan migrate --seed

    The --seed option is optional. If you don't need sample data, omit it.

  8. Compile Frontend Assets:

    Eazy utilizes frontend frameworks for its user interface. Compile these assets using:

    npm install && npm run dev  # Or yarn install && yarn dev if using yarn

    This command will install the required frontend dependencies and compile the assets for the application.

  9. Run Database Migrations and Start Development Server:

Apply database migrations (if you haven't already) and start the Laravel development server:

Bash

This command will initiate the development server, typically accessible at http://localhost:8000 in your web browser For Testing puposes.

Installation Steps (Frontend):

  1. Navigate to Project Directory:

    Open your terminal and navigate to the extracted directory using the cd command:

    Bash

  2. Install Application Dependencies:

    Npm manages the application's third-party libraries. Run the following command to install them:

    Bash

  3. Build Next.js Application:

    Build the Next.js frontend for optimized performance:

    Bash

    This will create a new application key and store it in the .env environment file.

  4. Start Development Server (Optional):

    To run the Next.js development server for live updates, navigate to the frontend directory and use:

    Bash

    Use code with caution.content_copy

    This will typically start the server on http://localhost:3000.

Project Structure:

The Eazy application has a separated directory structure for the Laravel backend and Next.js frontend. Here's a general overview:

  • backend (or similar): Contains the Laravel application files (app, config, database, etc.).

  • frontend (or similar): Contains the Next.js frontend files (pages, components, public, etc.).

Last updated