Ecommerce Lite - Laravel Project

Table of Contents

• Introduction
• Features
• Getting Started
  • Prerequisites
  • Installation
  • Configuration
• Usage
• API Endpoints
• Contributing
• Acknowledgements
• Additions
• Contact

Introduction

EcomLite is a lightweight e-commerce RESTful API built with Laravel. It demonstrates the implementation of core e-commerce functionalities, including product management, order processing, authentication, and search capabilities. The project follows clean code principles and leverages Laravel features such as caching, pagination, validation, and event-driven architecture to deliver a scalable and maintainable backend application.

This project was built to showcase practical backend engineering skills and modern Laravel development practices while providing a solid foundation that can be extended with additional features and integrations.

Features

• Product management (Create, Read, Update, Delete)
• Product search and filtering by category and price
• Order placement with automatic stock validation and inventory updates
• API authentication using Laravel Sanctum
• Product caching for improved performance
• Event-driven notifications for order-related actions
• Robust request validation and product availability checks
• RESTful API design with proper HTTP status codes and structured JSON responses
• Scalable and maintainable architecture following Laravel best practices

Getting Started

Prerequisites

Make sure you have the following software installed :

• PHP >= 8.0
• Composer
• MySQL
• Laravel 9.x

Installation

Follow these steps to set up the project locally :

# Clone the repository
git clone https://github.com/YOUSSEIFJOO/ecomlite.git ecomlite

# Navigate into the project directory
cd ecomlite

# Install PHP dependencies
composer install

# Install Node.js dependencies
npm install

Configuration

1- Copy the .env.example file to .env and set your environment variables :

cp .env.example .env

2- Set your database credentials in the .env file :

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=ecomlite-db
DB_USERNAME=root
DB_PASSWORD=yourpassword

3- Generate the application key :

php artisan key:generate

4- Migrate the database :

php artisan migrate

Usage

To start the local server and test the application, use :

php artisan serve

Put These Values inside your .env :

API_KEY_SWAGGER_DOCS=9073d1808f1911ef8d830d5be99a1e44
SECRET_API_KEY=6e880ef08f7b11ef95ac175a6e3eb139

You can now access the application at http://localhost:8000.

API Endpoints

At rhe first run :

php artisan serve

Then open this URL in your browser :

http://127.0.0.1:8000/ecomlite/apis/9073d1808f1911ef8d830d5be99a1e44

Contributing

If you'd like to contribute :

1- Fork the repository.
2- Create your feature branch (git checkout -b feature/your-feature).
3- Commit your changes (git commit -m 'Add your feature').
4- Push to the branch (git push origin feature/your-feature).
5- Open a pull request.

Acknowledgements

• Laravel framework for its simplicity, flexibility, and power in building modern web applications.
• The open-source community for providing helpful packages and tools that enhance development.
• MySQL for reliable database management.
• Cache systems like Redis for optimizing performance in large-scale applications.

Additions

1. Laravel Octane: Explained as a way to improve performance with steps to install and run Octane.
2. Redis: Highlighted for caching, with instructions to configure it in the .env file.

• This will give the project a professional touch while indicating performance-focused suggestions for further improvements.

• Note : When you try to use ( Laravel Octane && Redis ) Ensure you installed the requirements on your machine at the first.

Contact

Developed by Yousseif Nady. Reach out at yousseifnady59@gmail.com for any questions or inquiries.