Shelf Mates (E-Commerce Project built on MERN Stack)🚀

Shelf-mates is an online E-commerce delivery platform I built on top of MERN Stack (MongoDB, Express, React, Node.js)

TL;DR

Shelf Mates implements an E-commerce Gorcery Delivery platform which has customer side as well as admin side features. Customer side has fully enabled CRUD operations for profile, cart, orders, reviews and addresses. While the client side has an Admin Dashboard with various Data-visualisations with the help of recharts library. It also provides general statistics and data for each product such as sales, stars and customer feedback. On the backend I've used MongoDB and express to make the API. I've also implemented a secure authentication system using JWT and storing them inside cookies.

How to run project

Client

1. To run this project, first run this command:

git clone https://github.com/Goldfish7718/Shelf-mates.git

2. Now run cd client and create a .env file and pass one environment variable: VITE_API_URL=http://<API_URL>. Replace <API_URL> with actual API URL
3. Now run 2 commands:

npm install
npm run dev

Server

1. First cd into the server folder with the following command: cd server

2. Now create a .env file and pass 4 Environment variables in it as follows:
   a. JWT_SECRET=<ANY_STRING>. Replace <ANY_STRING> with any string you wish.
   b. STRIPE_API_KEY=<YOUR_STRIPE_API_KEY>. Replace <STRIPE_API_KEY> with your actual Stripe API Key. c. ORIGIN=<CLIENT_URL>. Replace <CLIENT_URL> with actual client URL. d. DB_URI=<MONGODB_CONNECTION_STRING> and assign it your actual MongoDB connection string.

   If you don't have a Stripe API key, head over to Official Stripe website then Sign Up/Log in. Now go to developers tab and you should see two API keys. A Publishable Key and a Secret key. Copy the Secret key and paste it.

   Refer to .env.example for exact reference.

3. Now install dependencies and start the server

npm install
npm run dev

4. You should see the following message in the terminal. (You can change the port number if you want).

Server started on port 3000

Congratulations! You've successfully started both the servers

Deployment 🌐

• Shelf-mates is currently available here

Contact 🔗

• For any questions, please contact me on my email: [email protected]
• X/Twitter
• LinkedIn

Licenses 📃

• This project is licensed under the MIT License.