/laracommerce-api

REST API for E-Commerce platform with admin panel integration

Primary LanguagePHP

LaraCommerce REST API

REST API for E-Commerce platform with admin panel integration.

GitHub Workflow Status


| Admin Panel Features | Requirements | Install | How to setting | API Docs | License |

Admin Panel Features

  • Preview

  • Menu

    		Description
    Users Create employee and manage all users.
    Orders Manage the orders.
    Finances Manage the finances.
    Withdraw Manage the merchant's withdraw request.
    Bankings Create and manage available banking for merchant.
    Categories Create and manage available category for merchant's products.
    Profile Edit user's profile and password.

Requirements

PHP = ^8.1.x
laravel = ^9.x
kavist/rajaongkir = ^1.x
midtrans/midtrans-php = ^2.x
laravel/scout = ^9.x
filament/filament = ^2.x
beyondcode/laravel-websockets = ^1.x
pusher/pusher-php-server = ^7.x
flowframe/laravel-trend = ^0.1.x
barryvdh/laravel-debugbar = ^3.x
laravel-echo = ^1.15.x
pusher-js = ^8.x

Install

Clone repo

git clone https://github.com/muhammadhabibfery/laracommerce-api.git

Install Composer

Download Composer

composer update/install

composer install

Install Nodejs

Download Node.js

NPM dependencies

npm install

Run Vite

npm run dev

How to setting

Go into .env file change Database and Email credentials. Then setup some configuration with your own credentials

PUSHER_APP_ID=justRandomString
PUSHER_APP_KEY=justRandomString
PUSHER_APP_SECRET=justRandomString
PUSHER_HOST=127.0.0.1
PUSHER_PORT=6001
PUSHER_SCHEME=https|http   (Just choose one)
PUSHER_APP_CLUSTER=mt1

RAJAONGKIR_API_KEY=<Your-API-Key>

MIDTRANS_SERVER_KEY = <Your-Server-Key>
MIDTRANS_PRODUCTION = false
MIDTRANS_SANITIZED = true
MIDTRANS_3DS = true|false   (Just choose one)

<!-- If you are using algolia, change the scout_driver and setting your own algolia credentials -->
SCOUT_DRIVER=database

<!-- If you are using laravel valet and https protocol, add your valet path below -->
LARAVEL_WEBSOCKETS_SSL_LOCAL_CERT='/Users/YOUR-USERNAME/.config/valet/Certificates/VALET-SITE.TLD.crt'
LARAVEL_WEBSOCKETS_SSL_LOCAL_PK='/Users/YOUR-USERNAME/.config/valet/Certificates/VALET-SITE.TLD.key'
LARAVEL_WEBSOCKETS_SSL_PASSPHRASE=''

Run the migration

php artisan migrate

Or run the migration with seeder if you want seeding the related data

php artisan migrate --seed

Generate a New Application Key

php artisan key:generate

Create a symbolic link

php artisan storage:link

API Docs

Preview


Complete REST API Documentation can be found here

License

Copyright (C) 2023 Muhammad Habib Fery.
⬆ back to top