Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pintu544/e-commerce-api
Create a REST API for an e-commerce system using Node.js
https://github.com/pintu544/e-commerce-api
Last synced: 6 days ago
JSON representation
Create a REST API for an e-commerce system using Node.js
- Host: GitHub
- URL: https://github.com/pintu544/e-commerce-api
- Owner: pintu544
- Created: 2024-01-13T13:10:19.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-01-13T13:10:51.000Z (12 months ago)
- Last Synced: 2024-04-13T23:09:56.049Z (8 months ago)
- Language: JavaScript
- Size: 212 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
Awesome Lists containing this project
README
# eCommerce REST API
This is a REST API built using Node.js and Express.js for eCommerce. It provides endpoints for user authentication, product management, review management, and order management.
## Features
- User registration
- User login and logout
- Product creation, update, deletion, and retrieval
- Review creation, update, deletion, and retrieval
- Order creation, update, deletion, and retrieval
- Image upload for products
- JWT-based authentication
## Tech Stack
**Backend:**
- Node.js
- Express.js
- MongoDB
- Mongoose
- JWT
**Image Upload:**
- Cloudinary API
**Data Storage:**
- MongoDB
**User Authentication:**
- JSON Web Tokens (JWT)
## API Reference
#### User Authentication
- `POST /api/v1/auth/register` - Register a new user.
- `POST /api/v1/auth/login` - Login with an existing user.
- `GET /api/v1/auth/logout` - Logout the current user.
#### User
- `GET /api/v1/users` - Get all users.
- `GET /api/v1/users/:id` - Get single user.
- `GET /api/v1/users/showMe` - Show current user.
- `PATCH /api/v1/users/updateUser` - Update user profile.
- `PATCH /api/v1/users/updateUserPassword` - Update User Password.
#### Products
- `GET /api/v1/products` - Get all products.
- `POST /api/v1/products` - Create a new product.
- `POST /api/v1/products/uploadImage` - Upload an image for a product..
- `GET /api/v1/products/:id` - Get a single product by ID .
- `PATCH /api/v1/products/:id` - Update a product by ID .
- `DELETE /api/v1/products/:id` - Delete a product by ID .
- `GET /api/v1/products/:id/reviews` - Get a single product review.
#### Product Reviews
- `GET /api/v1/reviews` - Get all reviews for a product.
- `POST /api/v1/reviews` - Create a new review for a product.
- `GET /api/v1/reviews/:id` - Get a single review by ID.
- `PATCH /api/v1/reviews/:id` - Update a review by ID.
- `DELETE /api/v1/reviews/:id` - Delete a review by ID.
#### Order
- `GET /api/v1/orders` - Get all orders.
- `POST /api/v1/orders` - Create a order .
- `GET /api/v1/orders/:id` - Get a single order.
- `PATCH /api/v1/orders/:id` - Update a order.
- `GET /api/v1/orders/showAllMyOrder` - Get a current user orders.
## Installation
1. Clone the repository.
```
git clone https://github.com/pintu544/E-commerce-API.git
```
2. Navigate to the project directory.
```
cd E-commerce-API
```
3. Install the dependencies.
```
npm install
```
4. Set the environment variables in a .env file in the root directory of the project.
Example:
```
PORT=5000
MONGO_URL=mongodb://localhost/ecommerce
JWT_SECRET=your_secret_key_here
JWT_LIFETIME=1d
```
5. Start the application.
```
npm run dev
```