https://github.com/geekyash10/ecommerce-backend
The E-Commerce API is a RESTful web service designed for managing an online shopping platform. It includes essential features such as user authentication, product management, order placement, and admin operations. This API is built with role-based access control, ensuring secure and efficient management of user and admin activities.
https://github.com/geekyash10/ecommerce-backend
cookie expressjs jwt mongodb nodejs
Last synced: 3 months ago
JSON representation
The E-Commerce API is a RESTful web service designed for managing an online shopping platform. It includes essential features such as user authentication, product management, order placement, and admin operations. This API is built with role-based access control, ensuring secure and efficient management of user and admin activities.
- Host: GitHub
- URL: https://github.com/geekyash10/ecommerce-backend
- Owner: Geekyash10
- Created: 2024-04-05T10:47:22.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-01-01T05:37:17.000Z (over 1 year ago)
- Last Synced: 2025-03-03T12:43:58.654Z (over 1 year ago)
- Topics: cookie, expressjs, jwt, mongodb, nodejs
- Language: JavaScript
- Homepage:
- Size: 24.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# E-Commerce API
The E-Commerce API is a RESTful web service designed for managing an online shopping platform. It includes essential features such as user authentication, product management, order placement, and admin operations. This API is built with role-based access control, ensuring secure and efficient management of user and admin activities.
---
## Features
- User registration and login.
- Forgot password and reset functionality.
- Role-based access control for users and admins.
- Product listing, creation, update, and deletion.
- Order placement, tracking, and management.
- Review system for products.
- Centralized error handling and robust validation.
---
## API Reference
### Base URL
http://localhost:5000
---
### User Routes
| Method | Endpoint | Description | Access |
|--------|-------------------------|----------------------------------------------|---------|
| POST | `/register` | Register a new user. | Public |
| POST | `/login` | Log in a user. | Public |
| GET | `/logout` | Log out the current user. | Private |
| POST | `/password/forgot` | Request a password reset email. | Public |
| PUT | `/password/reset/:token`| Reset the password using the token. | Public |
| GET | `/me` | Fetch current user details. | Private |
| PUT | `/password/update` | Update the user’s password. | Private |
| PUT | `/me/update` | Update user profile information. | Private |
| GET | `/admin/users` | Fetch all users (Admin only). | Admin |
| GET | `/admin/user/:id` | Fetch a specific user (Admin only). | Admin |
| PUT | `/admin/user/:id` | Update user role (Admin only). | Admin |
| DELETE | `/admin/user/:id` | Delete a user (Admin only). | Admin |
---
### Product Routes
| Method | Endpoint | Description | Access |
|--------|------------------------------|----------------------------------------------|---------|
| GET | `/products` | Fetch all products. | Public |
| GET | `/product/:id` | Fetch details of a specific product. | Public |
| POST | `/admin/product/new` | Create a new product (Admin only). | Admin |
| PUT | `/admin/product/:id` | Update a product (Admin only). | Admin |
| DELETE | `/admin/product/:id` | Delete a product (Admin only). | Admin |
| PUT | `/review` | Add or update a review for a product. | Private |
| GET | `/reviews` | Fetch all reviews for a product. | Public |
| DELETE | `/reviews` | Delete a review for a product. | Private |
---
### Order Routes
| Method | Endpoint | Description | Access |
|--------|----------------------|----------------------------------------------|---------|
| POST | `/order/new` | Place a new order. | Private |
| GET | `/order/:id` | Fetch details of a specific order. | Private |
| GET | `/orders/me` | Fetch all orders of the logged-in user. | Private |
| GET | `/admin/orders` | Fetch all orders (Admin only). | Admin |
| PUT | `/admin/order/:id` | Update the status of an order (Admin only). | Admin |
| DELETE | `/admin/order/:id` | Delete an order (Admin only). | Admin |
---
## Installation
### Clone the Repository
```bash
git clone https://github.com/Geekyash10/Ecommerce-backend.git
cd Ecommerce-backend
npm install
```
## env file
```bash
PORT=5000
DB_URI=mongodb+srv://:@cluster.mongodb.net/ecommerce
JWT_SECRET=your_jwt_secret
JWT_EXPIRE=5d
COOKIE_EXPIRE=5
```
## Run the Server
```bash
node app.js