Home

Awesome

Laravel CRUD Operations Best Practices Example Beginner to Advanced

Tests

Getting Started ๐Ÿš€

These instructions will guide you through setting up the project on your local machine for development and testing.

Prerequisites

You need to have installed the following software:

Installing

Follow these steps to set up a development environment:

  1. Clone the repository

    git clone https://github.com/mr-punyapal/basic-crud.git
    
  2. Install dependencies

    composer install
    
    npm install
    
  3. Duplicate the .env.example file and rename it to .env

    cp .env.example .env
    
  4. Generate the application key

    php artisan key:generate
    
  5. Run migration and seed

    php artisan migrate --seed
    
  6. Run the application

    npm run dev
    
    php artisan serve
    

How to Test the Application ๐Ÿงช

Check composer.json for more details on scripts.

Installing with Sail

Laravel Sail is helpful when your local environment doesn't match with project requirements like different PHP versions. Only requirement is Docker to work with this project. For more details on Laravel Sail click here.

Follow these steps to set up a development environment using Laravel Sail:

  1. Clone the repository

    git clone https://github.com/mr-punyapal/basic-crud.git
    
  2. Duplicate the .env.example file and rename it to .env

    cp .env.example .env
    
  3. Install dependencies

    docker run --rm \
        -u "$(id -u):$(id -g)" \
        -v "$(pwd):/var/www/html" \
        -w /var/www/html \
        laravelsail/php83-composer:latest \
        composer install --ignore-platform-reqs
    
    ./vendor/bin/sail run --rm laravel.test npm install
    
  4. Run the application

    ./vendor/bin/sail up -d
    
    ./vendor/bin/sail npm run dev
    
  5. Generate the application key

    ./vendor/bin/sail artisan key:generate
    
  6. Run migration and seed

    ./vendor/bin/sail artisan migrate --seed
    

How to Test the Application with Sail ๐Ÿงช

Give Feedback ๐Ÿ’ฌ

Give your feedback on @MrPunyapal

Contribute ๐Ÿค

Contribute if you have any ideas to improve this project.