Laravel CoreUI Dashboard

This project is a Laravel-based dashboard that integrates the CoreUI admin template for a robust, responsive, and efficient backend management system. This guide provides detailed instructions to set up the project on your local environment.

Table of Contents

• Installation
  • Clone from GitHub
  • Laravel Configuration
  • NPM Configuration
  • Run Migrations
  • Run Seeders
  • Run Project
• Accessing the Dashboard
  • Login Credentials

Installation

Follow these steps to install the project on your local machine:

Clone from GitHub

1. Open your terminal, and run the following command to clone the repository to your local machine:

   git clone https://github.com/AzizbekDev/laravel-coreui-dashboard.git

2. After cloning, navigate into the project directory:

   cd laravel-coreui-dashboard

Laravel Configuration

3. Copy the .env.example file to create a new .env file for environment-specific settings:

   cp .env.example .env

4. Open the .env file in your preferred editor (e.g., nano, vim, or any text editor) and configure the following settings:

   • APP_NAME: Set the name of your application.
   • APP_URL: Set the url name of your application.
   • DB_CONNECTION, DB_DATABASE, DB_USERNAME, and DB_PASSWORD: Update these to match your local database settings.

   Example configuration in .env:

       APP_NAME=LaravelCoreUIDashboard
       APP_URL=http://localhost # by default localhost.
       DB_CONNECTION=sqlite # by default we use sqlite or change to mysql if necessary.
       # DB_HOST=127.0.0.1
       # DB_PORT=3306
       # DB_DATABASE=laravel
       # DB_USERNAME=root
       # DB_PASSWORD=

5. Create the SQLite database file:

   • Windows: Open PowerShell and run:

     New-Item -ItemType File "database\database.sqlite"

   • macOS or Ubuntu: Open Terminal and run:

     touch database/database.sqlite

6. Install the required Composer dependencies by running:

   composer install

7. Generate the application encryption key, which Laravel uses to secure session and other encrypted data:

   php artisan key:generate

NPM Configuration

8. Install the required Node.js dependencies by running:

   npm install

9. Once the dependencies are installed, compile the frontend assets using Laravel Mix:

   npm run dev

   If you are preparing the project for production, run:

   npm run build

Run Migrations

10. Run the following command to migrate the database and create the necessary tables:

    php artisan migrate

Run Seeders

11. Seed the database with initial data by running:

    php artisan db:seed

This will populate the database with default data, such as user roles and permissions.

Run Project

12. Finally, start the Laravel development server:

    php artisan serve

By default, the server will be available at: http://127.0.0.1:8000

Accessing the Dashboard

Once the project is running, open your browser and navigate to the dashboard at: http://127.0.0.1:8000/dashboard

Login Credentials

Use the following credentials to log in:

• Email: [email protected]
• Password: password

Notes:

Your Laravel CoreUI dashboard should now be up and running! If you need to make further customizations, refer to the Laravel and CoreUI documentation.

• Replace your-repo with the actual GitHub repository URL.
• The login credentials provided are the defaults as per the seeders, but you can modify them as needed.

This README.md file provides complete and clear instructions for setting up and running the project. Let me know if you want further customizations!