___                                        _       _ 
  ___  / __\___  _ __ ___  _ __ ___   ___ _ __ ___(_) __ _| |
 / _ \/ /  / _ \| '_ ` _ \| '_ ` _ \ / _ \ '__/ __| |/ _` | |
|  __/ /__| (_) | | | | | | | | | | |  __/ | | (__| | (_| | |
 \___\____/\___/|_| |_| |_|_| |_| |_|\___|_|  \___|_|\__,_|_|
                                                                                                 

Table of Contents

• Introduction
• Tools & Versions
• Prerequisites
• Installation
  • Vessel Setup
  • Project Setup
    • Configuration
    • Platform Setup
    • Notes
• Application Links
  • Platform
  • Portal
  • MailHog

Introduction

eCommercial is a web solution to manage commercial activites with ease.

Tools & Versions

Tool	Version
PHP	8.2.13
Laravel	10.33.0
Composer	2.6.5
Node.js	21.2.0
MySQL	8.1.0

Prerequisites

• Docker
• Vessel

Installation

Vessel Setup

First, make sure Docker is up running.

1. Clone the project

   mkdir ~/eexperts
   

   cd ~/eexperts
   

   git clone git@github.com:eexperts/vessel.git
   

2. Build and run the required containers for this project

   cd vessel
   

   ./build.sh
   

Project Setup

Configuration

1. Add the following entries into your /etc/hosts file

   echo "127.0.0.1 ecommercial.local api.ecommercial.local dashboard.ecommercial.local" >> /etc/hosts
   

2. Create a database named ecommercial in your local.

   sh connect.sh mysql
   

   mysql -uroot -proot
   

   CREATE DATABASE ecommercial;

Platform Setup

1. Clone our repository inside your eexperts folder ~/eexperts/

   cd ~/eexperts/
   

   git clone git@github.com:eexperts/ecommercial.git
   

2. Connect to php82 container where the project is hosted

   cd ~/eexperts/vessel
   

   sh connect.sh workspace
   

3. Install the dependencies

   cd /var/www/ecommercial/backend
   

   composer install
   

4. Migrate the tables

   php artisan migrate
   

5. Seed the shipping companies

   php artisan db:seed
   

Notes

• You need to run the following command inside php82 container to make queued jobs work:

  cd ~/eexperts/ecommercial/backend
  

  php artisan queue:work
  

Application Links

API

http://api.ecommercial.local

Portal

http://ecommercial.local

MailHog

http://localhost:8025