Laravel CRUD API

Project Description

The Laravel CRUD API project is a web application backend built using the Laravel PHP framework. It provides a robust API for performing CRUD (Create, Read, Update, Delete) operations on various resources, such as products, users, or any other customizable entities. The API supports file uploads and deletions, ensuring efficient management of associated resources. It includes features like validation and error handling to maintain data integrity and provide a smooth user experience.

Key Features

• CRUD Operations: Implements complete CRUD functionality to manage resources.
• File Handling: Allows users to upload and delete files associated with resources.
• User-Friendly Interface: Designed with an intuitive API structure for easy integration and usage.
• Validation and Error Handling: Implements robust validation rules and error handling mechanisms to ensure data consistency.
• Postman Collection: Includes a Postman collection for testing API endpoints and verifying functionality.
• MySQL Database: Utilizes MySQL as the relational database management system for data storage.

Technologies Used

• Laravel: A powerful PHP framework for building web applications and APIs.
• PHP: The programming language used for backend development.
• MySQL: A widely used relational database management system for storing application data.
• Bootstrap: Provides responsive design components for frontend elements.
• JavaScript: Used for interactive elements and client-side validation.

Setup and Usage

Installation Methods

1. Clone the Repository

   git clone https://github.com/yourusername/laravel-crud-api.git

2. Composer and NPM Installation

   composer install
   npm install

3. Environment Configuration

   • Rename .env.example to .env and configure database and other environment variables.

4. Database Setup

   • Run database migrations to create tables:

     php artisan migrate

   • Seed the database with sample data if needed:

     php artisan db:seed

5. Start Laravel Server

   php artisan serve

Manual Installation

1. Download ZIP File

   • Download the repository ZIP file from GitHub.

2. Setup Environment

   • Extract the ZIP file contents to your web server directory.
   • Configure .env file with database credentials.

3. Database Setup

   • Create a MySQL database.
   • Import the included MySQL dump file (database.sql) to populate the database.

4. Run Laravel

   • Navigate to the project directory.
   • Start the Laravel server:

     php artisan serve

Testing and Deployment

• Postman Collection: Use the provided Postman collection to test API endpoints for CRUD operations and file handling.
• Sample Database: Included SQL dump file (database.sql) can be used to populate the MySQL database with sample data for testing and development.

Contact Information

For inquiries or assistance regarding the project, please contact Mohamed Insath at [email protected].

Screenshots