https://github.com/deep0041/shopswift
A responsive e-commerce app built using MERN Stack
https://github.com/deep0041/shopswift
alpinejs api django ecommerce ecommerce-app express full-stack html5-css3 javascript mongodb nodejs python react redux
Last synced: about 2 months ago
JSON representation
A responsive e-commerce app built using MERN Stack
- Host: GitHub
- URL: https://github.com/deep0041/shopswift
- Owner: deep0041
- Created: 2025-04-04T22:20:35.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-04-09T18:50:39.000Z (about 2 months ago)
- Last Synced: 2025-04-09T18:54:56.313Z (about 2 months ago)
- Topics: alpinejs, api, django, ecommerce, ecommerce-app, express, full-stack, html5-css3, javascript, mongodb, nodejs, python, react, redux
- Language: JavaScript
- Size: 1.29 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
```markdown
# 🛍️ ShopSwift: Your E-Commerce Solution
_A responsive e-commerce app built using the MERN Stack_
---
## Table of Contents
1. [Introduction](#introduction)
2. [Features](#features)
3. [Tech Stack](#tech-stack)
4. [Installation](#installation)
5. [Usage](#usage)
6. [API Documentation](#api-documentation)
7. [Contributing](#contributing)
8. [License](#license)
9. [Contact](#contact)
10. [Releases](#releases)
---
## Introduction
Welcome to **ShopSwift**, a robust e-commerce application designed to provide a seamless shopping experience. Built on the **MERN stack**—MongoDB, Express, React, and Node.js—ShopSwift is fully responsive and can be easily deployed. This app not only allows users to browse products but also offers features like user authentication and a shopping cart.
---
## Features
- **User Authentication**: Secure login and registration using JWT.
- **Product Browsing**: View products with detailed information.
- **Responsive Design**: Optimized for mobile and desktop.
- **Shopping Cart**: Add products to the cart and proceed to checkout.
- **Admin Dashboard**: Manage products and users easily.
- **Real-time Notifications**: Stay updated with the latest offers.
---
## Tech Stack
- **Frontend**:
- React.js
- React Router Dom
- Redux
- Tailwind CSS
- **Backend**:
- Node.js
- Express.js
- MongoDB
---
## Installation
To set up the project on your local machine, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/deep0041/shopswift.git
cd shopswift
```
2. Install the dependencies for both frontend and backend:
```bash
# Navigate to the client directory
cd client
npm install
# Navigate back to the server directory
cd ../server
npm install
```
3. Set up your environment variables. Create a `.env` file in the server directory:
```plaintext
MONGODB_URI=your_mongodb_connection_string
JWT_SECRET=your_jwt_secret
```
4. Run the application:
```bash
# Start the server
cd server
npm start
# In another terminal, start the client
cd client
npm start
```
Now, your application should be running at `http://localhost:3000`.
---
## Usage
Once the app is running, visit `http://localhost:3000` in your browser.
1. **Sign Up/Login**: Create an account or log in to start shopping.
2. **Browse Products**: Navigate through various categories to find your desired items.
3. **Add to Cart**: Click on the "Add to Cart" button to include products in your shopping cart.
4. **Checkout**: Review your cart and proceed to payment.
---
## API Documentation
The backend exposes a RESTful API. Below are some key endpoints:
- **GET /api/products**: Fetch all products.
- **GET /api/products/:id**: Fetch a single product by ID.
- **POST /api/users/register**: Register a new user.
- **POST /api/users/login**: Authenticate user and return a token.
Refer to the documentation for detailed usage of each endpoint.
---
## Contributing
Contributions are welcome! Here’s how you can help:
1. Fork the repository.
2. Create your feature branch:
```bash
git checkout -b feature/AmazingFeature
```
3. Commit your changes:
```bash
git commit -m 'Add some AmazingFeature'
```
4. Push to the branch:
```bash
git push origin feature/AmazingFeature
```
5. Open a pull request.
---
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
---
## Contact
For any inquiries or suggestions, please reach out to me at [[email protected]](mailto:[email protected]).
---
## Releases
Check out the latest releases of ShopSwift [here](https://github.com/deep0041/shopswift/releases) to download the files and execute them.
[](https://github.com/deep0041/shopswift/releases)
---
### Acknowledgments
- Thank you to all contributors and users for your support.
- Special thanks to the developers of the MERN stack for providing such powerful tools.
---
Feel free to explore and contribute to the development of ShopSwift. Happy shopping!
```