Skip to content

Quick Start

Azizul Hakim edited this page Apr 2, 2024 · 3 revisions
  1. Choose Your Local Development Tool:

    Select your preferred local development tool, such as Laragon,Laravel Herd, XAMPP, WAMP, or any other tool that suits your needs.

    Version Requirments

    • Node 16+
    • PHP version 8.2+
    • MYSQL version 8.0+
  2. Configure Your Environment:

    Update your .env file with the correct database credentials.

    Copy .env.example to .env:

    Before proceeding, copy the .env.example file to .env to set up your environment variables:

    cp .env.example .env
  3. Install Dependencies:

    To install local development packages, including Husky and other Laravel-specific packages, run the following commands:

    npm install #for husky and other Laravel packages
    npx husky install #only once

    Run the following command to install the required dependencies using Composer:

    composer install
  4. Migrate and Seed the Database: Initialize and seed the database with default data using:

    php artisan migrate --seed

    Now, your project is ready for use. You can use the postman collection provided in the repo to start playing with the API. If you've run the seed command, log in with the provided credentials. Customize and expand your application as needed.

Clone this wiki locally