Welcome to the E Store project! This web application is built using Laravel and React.js, allowing users to shop for products, create accounts, and manage their shopping experience. This README file provides essential information about the project, including installation instructions, features, and API endpoints.
The Website Store project offers the following features:
-
User Authentication:
- Users can create accounts and log in securely using tokens.
-
Product Browsing:
- Users can view a list of available products.
-
Shopping Cart:
- Users can add products to their shopping cart.
- Users can update the quantity of items in their cart.
- Users can remove products from their cart.
-
Profile Management:
- Users can view their profile information.
-
Order Placement:
- Authenticated users can place orders for the items in their cart.
-
Order History:
- Authenticated users can view their order history.
-
Category Filtering:
- Users can filter products by category.
-
Search by name:
- user can search for products by name
To set up and run the Website Store project locally, follow these steps:
- Clone the Repository:
-
git clone https://github.com/halababe84/E.Store
- Install Dependencies:
- Install PHP dependencies:
composer install
- Install JavaScript dependencies:
npm install
- Database Configuration:
- Create a new database and configure the
.env
file with your database connection settings.
- Migrate and Seed the Database:
- Run the following commands to create and seed the database tables:
php artisan migrate php artisan db:seed
- Generate Application Key:
- Generate a unique application key:
php artisan key:generate
- Start the Development Server:
- Run the development server:
php artisan serve
- Additionally, start the frontend development server :
npm start
- Access the Website:
- Open your web browser and navigate to
http://localhost:8000
Here are the API endpoints used in this project:
-
User Authentication:
/register
- User registration
/login
- User login -
Product Management:
/products
- Get a list of products -
Shopping Cart:
/orders
- Create an order (requires authentication)
/updateorder/{order_id}/product/{product_id}
- Update product quantity in the order (requires authentication)
/deletefromorder/{order_id}/product/{product_id}
- Delete a product from the order (requires authentication) -
Profile Management:
/user
- Get user profile information (requires authentication) -
Order History:
/orders
- Get user order history (requires authentication) -
Category Management:
/categories
- Get a list of all product categories
/products/category/{categoryId}
- Get products by category
/products/search
- Search for products -
User Logout:
/logout
- User logout (requires authentication)
For any inquiries or feedback, please feel free to reach out to the project owner:
LinkedIn Profile: Ahmad Alhalabi
Thank you for using the Website Store project! Happy shopping!