-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
327f946
commit c6ae68c
Showing
1 changed file
with
68 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
# PIONEER PLASTICS | ||
|
||
Welcome to the "PIONEER PLASTICS" project, an e-product catalog website developed using the MERN stack. This README provides an overview of the project, its features, and how to get started. | ||
|
||
## Table of Contents | ||
|
||
1. [Introduction](#introduction) | ||
2. [Features](#features) | ||
3. [Getting Started](#getting-started) | ||
4. [Project Structure](#project-structure) | ||
5. [Technologies Used](#technologies-used) | ||
6. [Contributing](#contributing) | ||
7. [License](#license) | ||
|
||
## Introduction | ||
|
||
The "PIONEER PLASTICS" project is an e-commerce platform that allows users to explore a wide range of products, add them to their shopping cart, and make secure payments using PayPal. The project features user authentication, product management, and a seamless shopping experience. | ||
|
||
## Features | ||
|
||
- User registration and authentication. | ||
- Product catalog with categories. | ||
- Shopping cart management. | ||
- Secure payment processing with PayPal integration. | ||
- Role-based access control for administrators. | ||
- Responsive and user-friendly design. | ||
- Comprehensive API testing using Postman. | ||
- Database management using MongoDB. | ||
|
||
## Getting Started | ||
|
||
To run the "PIONEER PLASTICS" project on your local machine, follow these steps: | ||
|
||
1. Clone the repository: | ||
|
||
```bash | ||
git clone https://github.com/Daxrajsinh/Pioneer_Plastics.git | ||
|
||
2. Navigate to the project directory: | ||
|
||
```bash | ||
cd pioneer-plastics | ||
3. Install dependencies for both the client and server: | ||
```bash | ||
# Install client dependencies | ||
cd client | ||
npm install | ||
|
||
# Install server dependencies | ||
cd ../server | ||
npm install | ||
|
||
4. Start the development server: | ||
# Start the server (from the 'server' directory) | ||
npm start | ||
|
||
# Start the client (from the 'client' directory) | ||
npm run dax | ||
|
||
5. Open your web browser and visit http://localhost:3000 to access the application. | ||
|
||
Project Structure | ||
The project is organized into two main directories: | ||
|
||
/client: Contains the frontend code built with React. | ||
/server: Contains the backend code built with Node.js and Express. |