-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.md.txt
72 lines (65 loc) · 2.45 KB
/
README.md.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
<h1>E-Commerce Project</h1><br>
This is an E-commerce project built with the MERN stack and SCSS for styling. This project has been created as part of the web development learning process and showcases the use of various technologies and tools to create a full-fledged e-commerce website.<br>
<h1>Table of Contents</h1>
<h3>Features</h3>
<h3>Technologies Used</h3>
<h3>Installation</h3>
<h3>Usage</h3>
<h3>Contributing</h3>
<h3>License</h3>
<h3>Features</h3>
<h1>This e-commerce website includes the following features:</h1>
<h2>Features</h2>
<ul>
<li>User authentication and authorization</li>
<li>Product catalog with search, filter and sorting options</li>
<li>Shopping cart</li>
<li>Checkout process with payment integration</li>
<li>User profile with order history</li>
<li>Admin dashboard to manage products, orders, and users</li>
</ul>
<h2>Technologies Used</h2>
<ul>
<li>MongoDB</li>
<li>Express.js</li>
<li>React.js</li>
<li>Node.js</li>
<li>Redux</li>
<li>JWT authentication</li>
<li>Stripe payment integration</li>
<li>SCSS</li>
</ul>
<h2>Installation</h2>
<ol>
<li>Clone this repository to your local machine.</li>
<li>Navigate to the project directory.</li>
<li>Install the dependencies by running <code>npm install</code> in the terminal.</li>
<li>Set up environment variables by creating a <code>.env</code> file in the root directory and adding the following variables:
<ul>
<li><code>MONGO_URI</code>: MongoDB connection URI</li>
<li><code>JWT_SECRET</code>: JWT secret key</li>
<li><code>STRIPE_SECRET_KEY</code>: Stripe secret key</li>
</ul>
</li>
<li>Start the development server by running <code>npm run dev</code>.</li>
</ol>
<h2>Usage</h2>
<p>Once you have set up the project, you can use it to:</p>
<ul>
<li>Browse the product catalog</li>
<li>Add products to the cart</li>
<li>Checkout and pay for the order</li>
<li>View your order history</li>
<li>Manage products, orders, and users as an admin</li>
</ul>
<h2>Contributing</h2>
<p>Contributions to this project are welcome. To contribute, follow these steps:</p>
<ol>
<li>Fork this repository.</li>
<li>Create a new branch with your feature or bug fix.</li>
<li>Make your changes and commit them.</li>
<li>Push your changes to your forked repository.</li>
<li>Submit a pull request to this repository.</li>
</ol>
<h2>License</h2>
<p>This project is licensed under the <a href="https://opensource.org/licenses/MIT">MIT License</a>.</p>