README.md

E-commerce web-application for selling clothing essentials

tomper-wear.netlify.app (cloud-based)
tw.varuntiwari.com (self-hosted)

---

This is the frontend of TomperWear build with MERN stack and deployed with Netlify

🚀 Link to Admin panel, Backend

📷 Link to Screenshots

🎥 Link to Video demo

🧾 Description

TomperWear is an E-commerce platform for small bussiness owners who want to expand their bussiness by providing an online purchase solution to their customers.

✨ Features

Client

Users shopping through this platform enjoys following features:

• User authentication using google firebase.
• Secure payments via stripe.
• Users can change their username and display image.
• Users can filter products on various parameters.
• Users can sort products according to price and name.
• Users can add products to cart.
• Users can order products by providing their shipping information and card details for payments.
• Users can view their order's status and their previous orders.
• Users can review the products (or update their previous reviews) and benefit other customers.
• Users can send feedbacks to the owner.
• Responsive for all screen sizes.

Admin

The admin panel of TomperWear contains three classes of admins:

1. Super privileged admin Super privileged admins are the topmost in the hierarchy. They have the following permissions:

• Can view, create, update, and delete admin users.
• Can view, create, update, and delete products.
• Can view orders and update their status.
• Can delete orders.

This is privilege is ideal for the owner(s) of the bussiness.

2. Moderate privileged admin Moderate privileged admins comes below Super privileged admins. They have the following permissions:

• Can view, create, update, and delete admin users.
• Can view, create, update, and delete products.
• Can view orders and update their status.
• Can delete orders.

This is privilege is ideal for the manager(s).

3. Low privileged admin Low privileged admins are the lowermost in the hierarchy and have the least amount of privileges. The have the following permission:

• Can view, create, update, and delete admin users.
• Can view, create, update, and delete products.
• Can view orders and update their status.
• Can delete orders.

This is privilege is ideal for the delivery-agent(s).

Here is a table dipicting the admin privileges for better clarity

	Admins				Product				Orders
	view	create	update	delete	view	create	update	delete	view	update	delete
Super	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
Moderate	-	-	-	-	✔	✔	✔	✔	✔	✔	✔
Low	-	-	-	-	-	-	-	-	✔	✔	-

⚙ Tools and Technologies used

Client

1. React.js
2. React-icons
3. Styled-Components
4. Firebase
5. Stripe
6. Formspree

Admin panel

1. React.js
2. Chakra-ui
3. React-icons

Backend

1. Node.js
2. Express.js
3. MongoDB
4. JWT
5. Cloudinary
6. Bcrypt.js
7. Stripe

🛠 Installation and setup

1. Clone the repo to your local machine.

2. Install the required dependency for server using :

   npm install

3. Create a .env file and copy-paste the contents of .env.sample in it.

4. Start the dev server using :

   npm start

🏎 Creating production built

1. Create a production ready react app using the command :

   npm run build

🤝 Test user credentials

E-mail	Password
[email protected]	bob1212
[email protected]	test1212

🙌 Open souce programs

GirlScript Summer of Code 2022 (GSSoC'22)

🙌 Other events

Awarded as the Best Web App in Winter Projects organized by GDSC and AASF, IIITM, Gwalior

😎 Team Members

Varun Kumar Tiwari 2020IMT-112 LinkedIn Github

🙌 Thanks to all the contributors

⚖ License

MIT

(If you liked the project, give it star 😃)