e.com - Documentation

Repository Overview: The e.com repository is a Laravel-based eCommerce web application. It includes various components essential for an eCommerce platform, such as user authentication, product management, and order processing.

Project Setup:

1. Clone the Repository:

   git clone https://github.com/anirbansanu/e.com.git

2. Install Dependencies:

   cd e.com
   composer install
   npm install

   if any error occur on composer install command. please view db_templates/Dump20240714.sql import it on your MySql or MariaDB DBMS and then again run composer install command.

3. Environment Configuration: Copy .env.example to .env and configure your environment variables.

   cp .env.example .env
   php artisan key:generate

Database Setup:

1. Migration:

   php artisan migrate

2. Seeding:

   php artisan db:seed

Running the Application:

1. Development Server:

   php artisan serve

2. Compiling Assets:

   npm run dev

Folder Structure:

• app/: Application logic
• bootstrap/: Bootstrap files
• config/: Configuration files
• database/: Migrations and seeders
• public/: Public assets
• resources/: Views and assets
• routes/: Route definitions
• storage/: Logs and cached files
• tests/: Test cases

Key Features:

• User Authentication: Registration and login functionality.
• Product Management: CRUD operations for products.
• Order Management: Handling customer orders and transactions.

Admin UI: The admin UI is built using the jeroennoten/laravel-adminlte package. To install and configure it, follow these steps:

Not needed Required for setup project, it's just for information

1. Install the Package:

   composer require jeroennoten/laravel-adminlte

2. Publish the Configuration:

   php artisan adminlte:install

3. Customize the Admin Panel: Edit the configuration file config/adminlte.php to customize the admin panel according to your requirements.

Contributing: To contribute, fork the repository, create a new branch, and submit a pull request with detailed information on the changes.

License: This project is licensed under the MIT License.

For more details, visit the GitHub repository.